From 4918c152b5a9451f9a479419af5aacb9c0287e99 Mon Sep 17 00:00:00 2001 From: silverweed Date: Thu, 25 Jul 2024 18:02:31 +0200 Subject: [PATCH] update readme --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index ef94e78..b8fa221 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,19 @@ $ ./rntviewer ntpl lmext1.root ``` ### Usage +Basic usage is: ``` $ ./rntviewer ``` + +This will open a window and let you browse the RNTuple, jump around its sections and get some +information about them. + +There is also a non-interactive non-graphical mode that can be used in a terminal (useful +e.g. for ssh sessions): +``` +$ ./rntviewer -t +``` + +The `-t` flag enables terminal mode. Use `./rntviewer -h` to get a help message about the +other flags that rntviewer accepts and are particularly useful in non-interactive mode.