aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMohammad Akhlaghi <mohammad@akhlaghi.org>2018-12-05 11:58:49 +0000
committerMohammad Akhlaghi <mohammad@akhlaghi.org>2018-12-05 11:58:49 +0000
commit631eeb1302628ce0cd4e84d30553bb77934e3dcf (patch)
tree91f60b609fc9e868539b4324bb9da4399d8156a5
parent3ddbaa75483f0fc14ad2840f6aa1478ad2c1b902 (diff)
Updated README.md
The README.md file was updated to reflect recent changes in the pipeline (especially regarding the downloader).
-rw-r--r--README.md30
1 files changed, 15 insertions, 15 deletions
diff --git a/README.md b/README.md
index 3949fad..2b990e3 100644
--- a/README.md
+++ b/README.md
@@ -4,13 +4,13 @@ Reproduction pipeline for paper XXXXXXX
This is the reproduction pipeline for the paper titled "**XXXXXX**", by
XXXXXXXX et al. (**IN PREPARATION**).
-To reproduce our results, the only dependency is **Wget**, and a minimal
-Unix-based building environment including a C compiler (already available
-on your system if you have ever built and installed a software from
-source). Note that **Git is not mandatory**: if you don't have Git to run
-the first command below, go to the URL given in the command on your
-browser, and download them manually (there is a button to download a
-compressed tarball of the project).
+To reproduce our results, the only dependency is a minimal Unix-based
+building environment including a C compiler (already available on your
+system if you have ever built and installed a software from source) and a
+downloader (Wget or cURL). Note that **Git is not mandatory**: if you don't
+have Git to run the first command below, go to the URL given in the command
+on your browser, and download them manually (there is a button to download
+a compressed tarball of the project).
```shell
$ git clone XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
@@ -44,14 +44,14 @@ This pipeline was designed to have as few dependencies as possible.
1.2: (OPTIONAL) 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. [[TO PIPELINE DESIGNERS: it is STRONGLY
- RECOMMENDED to keep a backup of all the necessary software tarballs
- you need for the project (possibly in another Git repository). If
- you do have such a link, add it here. If not, remove the
- placeholder and the previous sentence. Also, don't forget to remove
- this note.]]
+ used. Otherwise, a downloader (`wget` or `curl`) will be necessary
+ to download any necessary tarball. The necessary tarballs are also
+ collected in the link below for easy download. [[TO PIPELINE
+ DESIGNERS: it is STRONGLY RECOMMENDED to keep a backup of all the
+ necessary software tarballs you need for the project (possibly in
+ another Git repository). If you do have such a link, add it
+ here. If not, remove the placeholder and the previous
+ sentence. Also, don't forget to remove this note.]]
https://XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX