aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMohammad Akhlaghi <mohammad@akhlaghi.org>2018-02-08 01:26:00 +0100
committerMohammad Akhlaghi <mohammad@akhlaghi.org>2018-02-08 01:26:00 +0100
commit81558e2c3f8935d800220dce9ef4866b09de2fd1 (patch)
tree59307c95595142540ba26bf91191e17e3554cdce
parent6a1bc7481b204988b76f974cf37cc8875c8e582d (diff)
Usage of configure command added to README
The README file didn't match the current way to set the top-level directories (through `./configure'), it was still the old-fashioned way of manually finding and opening the file. The explanation is now corrected.
-rw-r--r--README15
1 files changed, 5 insertions, 10 deletions
diff --git a/README b/README
index 43810d5..2de59ba 100644
--- a/README
+++ b/README
@@ -14,17 +14,12 @@ To reproduce the results, please take these steps in order:
1. Make sure you have the dependencies (below).
-2. Edit `reproduce/config/pipeline/DIRECTORIES.mk'.
+2. Configure/set your top-level directories with the command below. It is
+ recommended to modify the directories. Please read the comments (lines
+ starting with an `#') in the file that is opened by `./configure' and
+ set the directories accordingly.
- This file keeps the important top-level directories for this pipeline in
- your system. Open it with a text editor and give the necessary
- locations. The comments in this file (lines starting with a `#') should
- help in understanding the purpose of each directory.
-
- In short, if you don't have the input files on your system, this
- pipeline will download them in the specified directory. Also, the
- intermediate/build directory may be relatively large (~1GB), so please
- choose a build location with sufficient space.
+ $ ./configure
3. Run the following command to reproduce everything on 8 threads. If your
CPU has a different number of threads, change the number.