From 39fee20485d8db270d004d8f3f7b859931d97552 Mon Sep 17 00:00:00 2001 From: Mohammad Akhlaghi Date: Thu, 22 Nov 2018 14:12:16 +0000 Subject: Spell check in two READMEs A spellcheck was run on the two README files. --- README-pipeline.md | 11 ++++++----- README.md | 4 ++-- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/README-pipeline.md b/README-pipeline.md index b1ff5c6..f0db32c 100644 --- a/README-pipeline.md +++ b/README-pipeline.md @@ -27,7 +27,7 @@ repository](https://gitlab.com/makhlaghi/reproducible-paper-dependencies). The output](https://gitlab.com/makhlaghi/reproducible-paper-output/raw/master/paper.pdf) of this pipeline is also present in [a separate repository](https://gitlab.com/makhlaghi/reproducible-paper-output). Notice -the last paragraph of the Acknowledgements where all the dependencies are +the last paragraph of the Acknowledgments where all the dependencies are mentioned with their versions. Below, we start with a discussion of why Make was chosen as the high-level @@ -339,7 +339,7 @@ All processing steps are assumed to ultimately (usually after many rules) end up in some number, image, figure, or table that are to be included in the paper. The writing of the values into the final report is managed through separate LaTeX files that only contain macros (a name given to a -number/string to be used in the LaTEX source, which will be replaced when +number/string to be used in the LaTeX source, which will be replaced when compiling it to the final PDF). So usually the last target in a Makefile is a `.tex` file (with the same base-name as the Makefile, but in `$(BDIR)/tex/macros`). This intermediate TeX file rule will only contain @@ -427,7 +427,7 @@ been explained here), please let us know to correct it. As described above, the concept of a reproduction pipeline heavily relies on [version control](https://en.wikipedia.org/wiki/Version_control). Currently this -pipline uses Git as its main version control system. If you are not already +pipeline uses Git as its main version control system. If you are not already familiar with Git, please read the first three chapters of the [ProGit book](https://git-scm.com/book/en/v2) which provides a wonderful practical understanding of the basics. You can read later chapters as you get more @@ -565,7 +565,7 @@ advanced in later stages of your work. discussed here. - `paper.tex`: Delete the text of the abstract and the paper's main - body, *except* the "Acknowledgements" section. This reproduction + body, *except* the "Acknowledgments" section. This reproduction pipeline was designed by funding from many grants, so its necessary to acknowledge them in your final research. @@ -958,4 +958,5 @@ results of anything that is to carry the "scientific" label. Any result that is not reproducible (due to incomplete information by the author) is not scientific: the readers have to have faith in the subjective experience of the authors in the very important choice of configuration values and -order of operations: this is contrary to the scientific spirit. \ No newline at end of file +order of operations: this is contrary to the scientific spirit. +LocalWords: README md et al Gitlab ApJS BDIR un pdf mk foreach diff --git a/README.md b/README.md index 9e77bf0..3949fad 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ This pipeline was designed to have as few dependencies as possible. below for easy download. [[TO PIPELINE DESIGNERS: it is STRONGLY RECOMMENDED to keep a backup of all the necessary software tarballs you need for the project (possibly in another Git repository). If - you do have such a link, add it here. If not, remove teh + you do have such a link, add it here. If not, remove the placeholder and the previous sentence. Also, don't forget to remove this note.]] @@ -60,7 +60,7 @@ This pipeline was designed to have as few dependencies as possible. recommended to set directories outside the current directory. Please read the description of each necessary input clearly and set the best value. Note that the configure script also downloads, builds and locally - installs (only for this pipeline, no root previlages necessary) many + installs (only for this pipeline, no root privileges necessary) many programs (pipeline dependencies). So it may take a while to complete. ```shell -- cgit v1.2.1