aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorMohammad Akhlaghi <mohammad@akhlaghi.org>2018-11-18 22:59:49 +0000
committerMohammad Akhlaghi <mohammad@akhlaghi.org>2018-11-18 22:59:49 +0000
commit9f17ada30e13ffb0670c3ab3244298e79af74ab6 (patch)
tree0f2a727b26c82783a53c3d5f0e0f1c997cf80245 /README
parent6a9990b5a4d13d7628902b0dc067c74e782922de (diff)
Updated README and README.md for new dependency building features
The two README files have been updated to explain the new feature of downloading and building dependencies.
Diffstat (limited to 'README')
-rw-r--r--README18
1 files changed, 13 insertions, 5 deletions
diff --git a/README b/README
index fbbc7f6..b860090 100644
--- a/README
+++ b/README
@@ -10,12 +10,20 @@ pipeline, please see the link below:
Running the pipeline
====================
-1. Necessary dependency: LaTeX.
+1. Necessary dependencies:
- Other than LaTeX, this pipeline just needs some basic building tools
- that are already present if you have ever build a software from source
- (Tar, C compiler, and Make). The pipeline will build its own
- dependencies when you run `./configure'.
+ 1.1: Basic software building tools like C compiler, Make, and other
+ tools found on most Unix-like systems (GNU/Linux, BSD, Mac OS, and
+ others). All necessary dependencies will be built from source by
+ the `./configure' script (next step).
+
+ 1.2: Tarball of dependencies. If they are already present (in a
+ directory given at configuration time), they will be
+ used. Otherwise, *GNU Wget* will be used to download any necessary
+ tarball. The necessary tarballs are also collected in the link
+ below for easy download:
+
+ https://gitlab.com/makhlaghi/reproducible-paper-dependencies
2. Configure the environment (top-level directories in particular) and
build all the necessary software for use in the next step. It is