diff --git a/README.md b/README.md index 7339614..83301a7 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,8 @@ $ git clone --recurse-submodules ``` ### 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: - 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. +For the terminal-only version you don't need GLFW3, ImGui or OpenGL support. + ### Building 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: @@ -33,6 +36,11 @@ You can test that the tool is working properly with: $ ./rntviewer lmext1.root ntpl ``` +To build the terminal-only version: +``` +$ make nogfx_r +``` + ### Usage Basic usage is: ```