aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRaul Infante-Sainz <infantesainz@gmail.com>2020-04-13 11:23:04 +0100
committerRaul Infante-Sainz <infantesainz@gmail.com>2020-04-13 11:23:04 +0100
commit5a00d96db23740fba6c48deebd2a96e285f86f61 (patch)
tree1073c095a4cadc555a55d5f39ba43ffd59eb2675
parente965690e68ecf1217e7dab2228325796ddf9d120 (diff)
Added short line to inform that there are tutorials
With this commit, a short line telling that Maneage has tutorials showing the workflow in a practical way has been added. Because of we are near to the limit of words, I have added just a very short line. The sentence does not specify any file name since the tutorial(s) is not included (it will be in a near future).
-rw-r--r--paper.tex1
1 files changed, 1 insertions, 0 deletions
diff --git a/paper.tex b/paper.tex
index 0d5e993..c0edcc1 100644
--- a/paper.tex
+++ b/paper.tex
@@ -314,6 +314,7 @@ The main Maneage Branch is a fully working skeleton of a project without much fl
To start a new project, the authors will \emph{clone}\footnote{In Git, the ``clone'' operation is the process of copying all the project's files and history from a repository onto the local system.} Maneage, create their own Git branch over the latest commit, and start their project by customizing that branch.
Customization in their project branch is done by adding the names of the software they need, references to their input data, adding the analysis commands and commands to generate the visualizations, and write the narrative report which includes the visualizations.
Manages contains a file called \inlinecode{README-hacking.md} that has a complete checklist of steps to start a new project and remove demonstration parts.
+In order to start using Maneage, there are hands-on tutorials for guiding the reader through research examples and show the workflow in a practical way.
This will usually be done in multiple commits in the project's duration (maybe multiple years), thus preserving the project's history: the causes of all choices, the authors and times of each change, failed tests, and etc.
Figure \ref{fig:files} shows this directory structure containing the modular plain-text files (classified by context in sub-directories) and some representative files in each directory.