aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMohammad Akhlaghi <mohammad@akhlaghi.org>2018-02-08 02:28:08 +0100
committerMohammad Akhlaghi <mohammad@akhlaghi.org>2018-02-08 02:28:08 +0100
commit65d9e1b9d1a6582fbf90f83d39a629ef25cee2b1 (patch)
tree7f48dde9a2c205114c3edd79f5308efcb35a9d93
parent81558e2c3f8935d800220dce9ef4866b09de2fd1 (diff)
Instructions to delete README.md before starting
`README.md' is for this pipeline, not the research project that is using it. Therefore it might be confused with the `README' that is devoted to the research project. So in the checklist, a point was added to delete this file before making the first new commit.
-rw-r--r--README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/README.md b/README.md
index 391bed2..bffd9a0 100644
--- a/README.md
+++ b/README.md
@@ -205,6 +205,11 @@ been explained here), please let us know to correct it.
necessary for your research to the pipeline based on the example
above.
+ - **Delete this `README.md`**: `README.md` is designed for this template,
+ not your reproduction pipeline. So to avoid later confusion, delete it
+ from your own repository (you may want to keep a copy outside for the
+ notes and discussions below until you are familiar with it).
+
- **Initiate a new Git repo**: You don't want to mix the history of this
template reproduction pipeline with your own reproduction
pipeline. You have already made some small changes in the previous