diff options
| author | Mohammad Akhlaghi <mohammad@akhlaghi.org> | 2018-11-22 14:04:38 +0000 |
|---|---|---|
| committer | Mohammad Akhlaghi <mohammad@akhlaghi.org> | 2018-11-22 14:04:38 +0000 |
| commit | fc909fe92ed69417c7b75581cae5179d451bc46e (patch) | |
| tree | 75f089131e4e90171a3792c1a729879b86492732 | |
| parent | 61b6b019374ce541b2b1e66470226de289c60a4b (diff) | |
Placeholder in README.md for pipeline dependencies
A placeholder link is now used in `README.md' to encourage the pipeline
designers to keep a backup of all the dependencies they use.
| -rw-r--r-- | README-pipeline.md | 14 | ||||
| -rw-r--r-- | README.md | 10 |
2 files changed, 15 insertions, 9 deletions
diff --git a/README-pipeline.md b/README-pipeline.md index 1df62ca..b1ff5c6 100644 --- a/README-pipeline.md +++ b/README-pipeline.md @@ -583,13 +583,13 @@ advanced in later stages of your work. - **`README.md`**: Correct all the `XXXXX` place holders (name of your project, your own name, address of pipeline's online/remote - repository). Read over the text and update it where necessary to fit - your project. Don't forget that this is the first file that is - displayed on your online repository and also your colleagues will - first be drawn to read this file. Therefore, make it as easy as - possible for them to start with. Also check and update this file one - last time when you are ready to publish your work (and its - reproduction pipeline). + repository, link to download dependencies and etc). Generally, read + over the text and update it where necessary to fit your project. Don't + forget that this is the first file that is displayed on your online + repository and also your colleagues will first be drawn to read this + file. Therefore, make it as easy as possible for them to start + with. Also check and update this file one last time when you are ready + to publish your work (and its reproduction pipeline). - **Your first commit**: You have already made some small and basic changes in the steps above and you are in the `master` branch. So, you @@ -46,9 +46,15 @@ This pipeline was designed to have as few dependencies as possible. 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: + below for easy download. - https://gitlab.com/makhlaghi/reproducible-paper-dependencies + https://XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + + [TO PIPELINE DESIGNERS: IT IS <<<STRONGLY RECOMMENDED>>> TO KEEP A + BACKUP OF ALL THE NECESSARY TARBALLS YOU NEED FOR THE PROJECT + (POSSIBLY IN ANOTHER GIT REPOSITORY). IF YOU DO MAKE ONE, PUT ITS + URL IN THE PLACEHOLDER URL ABOVE. IF NOT, REMOVE THE PLACE HOLDER + AND THE LAST LINE OF THE PRAGRAPH ABOVE IT.] 2. Configure the environment (top-level directories in particular) and build all the necessary software for use in the next step. It is |