silverweed/rntviewer
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update README

Browse source
This commit is contained in:
silverweed 2024-08-21 14:38:26 +02:00
parent b5561b86ca
commit 49fb558215
1 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -10,7 +10,8 @@ $ git clone --recurse-submodules <repo_url>
``` ```
### Dependencies ### Dependencies
rntviewer currently only works on Linux (PRs welcome). rntviewer currently only fully works on Linux, with the terminal-only version working
on MacOS as well (PRs welcome).
The dependencies are: The dependencies are:
- GLFW3 (`libglfw3-dev` on debian, `glfw-devel` on fedora, `glfw` on arch) - GLFW3 (`libglfw3-dev` on debian, `glfw-devel` on fedora, `glfw` on arch)
@ -21,6 +22,8 @@ Other than those, rntviewer depends on Dear ImGui and GLAD (both included in the
The machine must support OpenGL 3.3 or higher. The machine must support OpenGL 3.3 or higher.
For the terminal-only version you don't need GLFW3, ImGui or OpenGL support.
### Building ### Building
Building is done with `make`. Make sure to `source /path/to/root/bin/thisroot.sh` before running it. Building is done with `make`. Make sure to `source /path/to/root/bin/thisroot.sh` before running it.
You probably want to build the release version: You probably want to build the release version:
@ -33,6 +36,11 @@ You can test that the tool is working properly with:
$ ./rntviewer lmext1.root ntpl $ ./rntviewer lmext1.root ntpl
``` ```
To build the terminal-only version:
```
$ make nogfx_r
```
### Usage ### Usage
Basic usage is: Basic usage is:
``` ```