From 595626499d20c6e3b297e72c90b5bd3f4d528e8a Mon Sep 17 00:00:00 2001 From: Mohammad Akhlaghi Date: Fri, 24 Aug 2018 17:23:13 +0200 Subject: Minor edits After a full trial of the checklist, some further minor edits were made to make it more clear. --- README.md | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 56e7d6c..1ee2c12 100644 --- a/README.md +++ b/README.md @@ -545,19 +545,20 @@ advanced in later stages of your work. $ make clean # Clean already built pipeline outputs. $ make # Build the pipeline to ensure everything is fine. $ git add -u # Stage all the changes. + $ git status # Make sure everything is fine. $ git commit # Your first commit, add a nice description. $ git tag -a v0 # Tag this as the zero-th version of your pipeline. ``` - - **Remote repository**: You can use any [hosting + - **Setup the remote**: You can use any [hosting facility](https://en.wikipedia.org/wiki/Comparison_of_source_code_hosting_facilities) - you prefer to keep an online copy of your project's version controlled - history. We recommend [GitLab](https://gitlab.com) because it allows - any number of private repositories for free and because you can host - GitLab on your own server. Create an account in your favorite service - (if you don't already have one), and define a new project there. It - will give you a link (ending in `.git`) that you can put in place of - `XXX` in the command below. + that supports Git to keep an online copy of your project's version + controlled history. We recommend [GitLab](https://gitlab.com) because + it allows any number of private repositories for free and because you + can host GitLab on your own server. Create an account in your favorite + hosting facility (if you don't already have one), and define a new + project there. It will give you a link (ending in `.git`) that you can + put in place of `XXX` in the command below. ```shell git remote add origin XXX @@ -568,8 +569,10 @@ advanced in later stages of your work. - **Start your exciting research**: You are now ready to add flesh and blood to this raw skeleton by further modifying and adding your exciting research steps. You can use the "published works" section in - the introduction as some fully working models to learn from. Also, - don't hesitate to contact us if you have any questions. + the introduction (above) as some fully working models to learn + from. Also, don't hesitate to contact us if you have any + questions. Any time you are ready to push your commits to the remote + repository, you can simply use `git push`. - **Pre-publication: add notice on reproducibility**: Add a notice somewhere prominent in the first page within your paper, informing the -- cgit v1.2.1