From 545c97176e2967da6e38e8ca2a4bf73e20c8ca7e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?V=C3=A9ronique=20=20LEGRAND?= <veronique.legrand@pasteur.fr> Date: Tue, 25 May 2021 15:19:54 +0000 Subject: [PATCH] Update README.md --- README.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 78dee41..1e52ec6 100644 --- a/README.md +++ b/README.md @@ -43,14 +43,36 @@ A way to install ROCK on your system without sudo rights is to provide the confi ./configure --prefix=my_home/my_tools ``` +Once You have ran ./configure with the options that suit you best, you can check that ROCK works well on your system by running: + ```bash -./configure make check +``` + +Make check will compile the code and generate an executable in a temporary location. Then, it will run all unit tests and non regression tests. +This is not a mandatory step. It eveything goes well, you can go on. Otherwise, you can report the problem to the authors. + +To generate the executable, simply run: + +```bash make +``` + +and to install it, run either + +```bash +sudo make install +``` + +or + +```bash make install ``` -This will create the executable _rock_ that can be run with the following command line model: +depending on whether you used --prefix or not with ./configure. + +The executable _rock_ can be run with the following command line model: ```bash ./rock [options] -- GitLab