diff --git a/README.md b/README.md index b1acbdc27e870ba7d4e83eac01127c675012bd15..78dee416997dcfdf7b964100f6270d1c3ad94a83 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,31 @@ git clone https://gitlab.pasteur.fr/vlegrand/ROCK.git _ROCK_ is developped in C++ 98 and is C++11 compatible. -On computers with [gcc](https://ftp.gnu.org/gnu/gcc/) (version at least 4.4.7) or [clang](https://clang.llvm.org/) (version at least 503.0.40) installed, the compilation and installation of _ROCK_ can be carried out using the following command lines: +On computers with [gcc](https://ftp.gnu.org/gnu/gcc/) (version at least 4.4.7) or [clang](https://clang.llvm.org/) (version at least 503.0.40) installed, the compilation and installation of _ROCK_ can be carried out easily: + +If you don't plan to add new files to ROCK's source code, you do not need anything else than one of the compilers mentionned above and the make tool. +First thing to do is to run: + +```bash +./configure +``` + +This will generate the files needed by make to produce the executable with the default options. + +Two things are important here: +1) To get the best performances, you must pass the -O3 flag: + +```bash +./configure CFLAGS='-O3' CXXFLAGS='-O3' +``` + +2) You do not need to install ROCK on your system to use it. You can simply run the executable that make generates in the src directory. +Yet, if you want to install it in your system's default location for executables; then make sure that you have sudo rights for that. +A way to install ROCK on your system without sudo rights is to provide the configure script with another directory path. This can be done with the --prefix option of the configure script. + +```bash +./configure --prefix=my_home/my_tools +``` ```bash ./configure