diff options
| author | Zahra Sharbaf <zahra.sharbaf2@gmail.com> | 2020-04-26 08:50:49 +0430 |
|---|---|---|
| committer | Mohammad Akhlaghi <mohammad@akhlaghi.org> | 2020-04-26 18:23:52 +0100 |
| commit | 3409a54c74e522ebac48546c2c5347dea6aeee16 (patch) | |
| tree | 1dea809d0474f4f354d35f6daa3be10d1da8221e | |
| parent | d058b0ca46efc179da2c826e40e934f8dd7edacb (diff) | |
README-hacking.md: described why automatic preparation only occurs once
Recently (since Commit 7d0c5ef77), the preparation is not run automatically
every time. It is only run automatically the first time and needs to be
manually called with the `--prepare-redo' option. But this wasn't explained
in `README-hacking.md' (currently the main documentation of Maneage).
With this commit, a description about invoking the preparation process
after the first attempt of the running project has been added to
`README-hacking.md'.
| -rw-r--r-- | README-hacking.md | 21 |
1 files changed, 20 insertions, 1 deletions
diff --git a/README-hacking.md b/README-hacking.md index dc09072..644de44 100644 --- a/README-hacking.md +++ b/README-hacking.md @@ -840,7 +840,26 @@ Other basic customizations case, please share your thoughts and suggestions with us, so we can add them here for everyone's benefit. - - **Pre-publication: add notice on reproducibility**: Add a notice + - **Re-preparation**: Automatic preparation is only run in the first run + of the project on a system, to re-do the preparation you have to use + the option below. Here is the reason for this: when its necessary, the + preparation process can be slow and will unnecessarily slow down the + whole project while the project is under development (focus is on the + analysis that is done after preparation). Because of this, preparation + will be done automatically for the first time that the project is run + (when `.build/software/preparation-done.mk` doesn't exist). After the + preparation process completes once, future runs of `./project make` + will not do the preparation process anymore (will not call + `top-prepare.mk`). They will only call `top-make.mk` for the + analysis. To manually invoke the preparation process after the first + attempt, the `./project make` script should be run with the + `--prepare-redo` option, or you can delete the special file above. + + ```shell + $ ./project make --prepare-redo + ``` + + - **Pre-publication**: add notice on reproducibility**: Add a notice somewhere prominent in the first page within your paper, informing the reader that your research is fully reproducible. For example in the end of the abstract, or under the keywords with a title like |