diff options
| -rw-r--r-- | README | 18 | ||||
| -rw-r--r-- | README.md | 15 | ||||
| -rw-r--r-- | reproduce/src/make/dependencies.mk | 2 |
3 files changed, 26 insertions, 9 deletions
@@ -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 @@ -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 diff --git a/reproduce/src/make/dependencies.mk b/reproduce/src/make/dependencies.mk index fe5fb19..156f254 100644 --- a/reproduce/src/make/dependencies.mk +++ b/reproduce/src/make/dependencies.mk @@ -267,7 +267,7 @@ $(ibdir)/latex: reproduce/config/pipeline/dependency-texlive.mk $$topdir/reproduce/config/pipeline/texlive.conf > texlive.conf ./install-tl --profile=texlive.conf cd .. - rm -rf install-tl-* + rm -rf install-tl-* $(tdir)/install-tl-unx.tar.gz # Put a symbolic link of the TeX Live executables in # `ibdir'. For `latex' do a copy, because it is the target of |