aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMohammad Akhlaghi <mohammad@akhlaghi.org>2018-11-22 12:53:53 +0000
committerMohammad Akhlaghi <mohammad@akhlaghi.org>2018-11-22 12:53:53 +0000
commitbd1e95c45668aedb39e70d1aae90a9bb86534506 (patch)
tree04bbe2cf3b97d2c7b2fac582eb3380b2ec0f2c30 /README.md
parent311572e0c1375429de998d70eb7d587d7b8032c4 (diff)
Using .local instead of ./.local in READMEs
Until now, in the instructions, we were suggesting to run `./.local/bin/make', but the `./' part is extra: this is already a directory and so the shell will be able to find it. So to make things more clear and easy to read/write, we removed the `./' part from the calls to our custom Make installation.
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/README.md b/README.md
index 720e804..239b527 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@ Introduction
This description is for *creators* of the reproduction pipeline. See
`README` for instructions on running it (in short, just download/clone it,
-then run `./configure` and `./.local/bin/make -j8`).
+then run `./configure` and `.local/bin/make -j8`).
This project contains a **fully working template** for a high-level
research reproduction pipeline, or reproducible paper, as defined in the
@@ -246,7 +246,7 @@ understand its architecture so you can navigate your way in the directories
and understand how to implement your research project within its
framework. But before reading this theoretical discussion, please run the
pipeline (described in `README`: first run `./configure`, then
-`./.local/bin/make -j8`) without any change, just to see how it works.
+`.local/bin/make -j8`) without any change, just to see how it works.
In order to obtain a reproducible result it is important to have an
identical environment (for example same versions the programs that it will
@@ -468,10 +468,10 @@ advanced in later stages of your work.
```shell
$ ./configure # Set top directories and build dependencies.
- $ ./.local/bin/make # Run the pipeline.
+ $ .local/bin/make # Run the pipeline.
# Open 'paper.pdf' and see if everything is ok.
- $ ./.local/bin/make clean # Delete high-level outputs.
+ $ .local/bin/make clean # Delete high-level outputs.
```
- **Copyright**, **name** and **date**: Go over the existing scripting
@@ -590,8 +590,8 @@ advanced in later stages of your work.
commit to be sure it works as expected).
```shell
- $ ./.local/bin/make clean # Delete outputs ('make distclean' for everything)
- $ ./.local/bin/make # Build the pipeline to ensure everything is fine.
+ $ .local/bin/make clean # Delete outputs ('make distclean' for everything)
+ $ .local/bin/make # Build the pipeline to ensure everything is fine.
$ git add -u # Stage all the changes.
$ git add README-pipeline.md # Keep this pipeline description.
$ git status # Make sure everything is fine.