From cfc133583d32f278b1b6486776273b6f07973947 Mon Sep 17 00:00:00 2001 From: Mohammad Akhlaghi Date: Fri, 24 Aug 2018 15:59:16 +0200 Subject: Step to check pipeline added in README.md checklist A step was added close to the top of the checklist to remind people to check the pipeline before making any changes. Also, the `--origin' option was removed from the `git clone' command into a separate command to rename the origin branch. This helps in readability. --- README.md | 25 +++++++++++++++++++++---- 1 file changed, 21 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a972258..74c2805 100644 --- a/README.md +++ b/README.md @@ -398,10 +398,27 @@ advanced in later stages of your work. research, while keeping up to date with improvements in the pipeline. ```shell - $ git clone --origin pipeline-origin https://gitlab.com/makhlaghi/reproducible-paper.git - $ mv reproducible-paper my-project-name - $ cd my-project-name - $ git checkout -b master + $ git clone https://gitlab.com/makhlaghi/reproducible-paper.git + $ mv reproducible-paper my-project-name # Your own directory name. + $ cd my-project-name # Go into the directory + $ git remote rename origin pipeline-origin # Rename the pipeline's remote. + $ git checkout -b master # Create, enter master branch. + ``` + + - **Test the pipeline**: Before making any changes, it is important to + test the pipeline and seeing if everything works. If there is any + problem in the `./configure` or `make` steps, please contact us to fix + the problem before continuing. After `make` is finished, open + `paper.pdf` and if it looks fine, you are ready to start customizing + the pipeline for your project. But before that, clean all the extra + pipeline outputs with `make clean` as shown below. + + ```shell + $ ./configure # Prepare the directory structure. + $ make # Run the pipeline. + + # Open 'paper.pdf' and see if everything is ok. + $ make clean # Remove all pipeline outputs. ``` - **Copyright**, **name** and **date**: Go over the existing scripting -- cgit v1.2.1