Browse Source

Added info in README

PeterParfenov 2 years ago
parent
commit
aa6fa313ce
1 changed files with 12 additions and 3 deletions
  1. 12 3
      README.md

+ 12 - 3
README.md

@@ -24,16 +24,25 @@ make
 
 ##### PicoDst data format
 
-After installation `setPicoDst.sh` will be generated. To make include `libPicoDst.so` in every `ROOT` session and to export usefull environment variables in the system, source `setPicoDst.sh`:
+After installation `setPicoDst.sh` will be generated. This script contains most of the needed information for the system to find PicoDst library.
+For comfortable usage of the `PicoDst` package (to automatically load `libPicoDst.so` in every `ROOT` session, export usefull environment variables and aliases in the system), source `setPicoDst.sh`:
 
 ```bash
 source setPicoDst.sh
 ```
+It also contains usefull aliases for all executables.
+
+##### Basic information about `PicoDst` package: `PicoDst-config`
+
+Like `root-config` command, `PicoDst-config` contains information about version and paths to the source code and build directories. After sourcing `setPicoDst.sh` one can just use the following command in bash:
+```bash
+PicoDst-config --version --incdir --srcdir --bindir
+```
 
 ##### Convert `MpdDst` data to `PicoDst`:
 
-If `FairRoot` (and `MpdRoot`) is installed `PicoDstConverter` is compiled. To use it, do:
+If `FairRoot` (and `MpdRoot`) is installed `PicoDstConverter` is compiled. After sourcing `setPicoDst.sh` one can use command:
 
 ```bash
-./PicoDstConverter -i input_mpddst.root -o output_picodst.root
+PicoDstConverter -i input_mpddst.root -o output_picodst.root
 ```