aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMohammad Akhlaghi <mohammad@akhlaghi.org>2018-11-14 09:43:04 +0000
committerMohammad Akhlaghi <mohammad@akhlaghi.org>2018-11-14 09:43:04 +0000
commit78727050424174fdee340190cdc458e491aaf18c (patch)
tree2aacb6c6bc975916c1f1d8eb125a7b9299043912 /README.md
parentdb97ea9a8f32050f74d8c981a9efa21f9e0dc512 (diff)
All used software with versions, acknowledged
All the used software are now acknowledged in the template paper along with their versions. This section is also mentioned in the check list, so users don't delete it by mistake.
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/README.md b/README.md
index 83b4265..7462251 100644
--- a/README.md
+++ b/README.md
@@ -525,8 +525,9 @@ advanced in later stages of your work.
respective files to remove and parts to fix are discussed here.
- `paper.tex`: Delete the text of the abstract and the paper's main
- body. Only keep a place holder text to later start writing your own
- contents.
+ body, *except* the "Acknowledgements" section. This reproduction
+ pipeline was designed by funding from many grants, so its necessary
+ to acknowledge them in your final research.
- `Makefile`: Delete the two lines containing `delete-me` in the
`foreach` loops. Just make sure the other lines that end in `\` are
@@ -548,7 +549,7 @@ advanced in later stages of your work.
commit to be sure it works as expected).
```shell
- $ make clean # Clean already built pipeline outputs.
+ $ make clean # Delete outputs ('make distclean' for all outputs)
$ make # Build the pipeline to ensure everything is fine.
$ git add -u # Stage all the changes.
$ git status # Make sure everything is fine.