aboutsummaryrefslogtreecommitdiff
path: root/README.md
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.md
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.md')
-rw-r--r--README.md15
1 files changed, 12 insertions, 3 deletions
diff --git a/README.md b/README.md
index 7462251..19da1df 100644
--- a/README.md
+++ b/README.md
@@ -18,11 +18,20 @@ by making it easy to start a project in this framework. As shown below, it
is very easy to customize this template reproducible paper pipeline for any
particular research/job and expand it as it starts and evolves. It can be
run with no modification (as described in `README`) as a demonstration and
-customized for use in any project as fully described below. The [final
-reproducible paper
+customized for use in any project as fully described below.
+
+The pipeline will download and build all the necessary libraries and
+programs for working in a closed environment (highly independent of the
+host operating system) with fixed versions of the necessary
+dependencies. The tarballs for building the local environment are also
+collected in a [separate
+repository](https://gitlab.com/makhlaghi/reproducible-paper-dependencies). The
+[final reproducible paper
output](https://gitlab.com/makhlaghi/reproducible-paper-output/raw/master/paper.pdf)
of this pipeline is also present in [a separate
-repository](https://gitlab.com/makhlaghi/reproducible-paper-output).
+repository](https://gitlab.com/makhlaghi/reproducible-paper-output). Notice
+the last paragraph of the Acknowledgements where all the dependencies are
+mentioned with their versions.
Below, we start with a discussion of why Make was chosen as the high-level
language/framework for this research reproduction pipeline and how to learn