IMPORTANT: Added publication checklist, improved relevant infrastructure

Possible semantic conflicts (that may not show up as Git conflicts but may
cause a crash in your project after the merge):

   1) The project title (and other basic metadata) should be set in
      'reproduce/analysis/conf/metadata.conf'. Please include this file in
      your merge (if it is ignored because of '.gitattributes'!).

   2) Consider importing the changes in 'initialize.mk' and 'verify.mk' (if
      you have added all analysis Makefiles to the '.gitattributes' file
      (thus not merging any change in them with your branch). For example
      with this command:
        git diff master...maneage -- reproduce/analysis/make/initialize.mk

   3) The old 'verify-txt-no-comments-leading-space' function has been
      replaced by 'verify-txt-no-comments-no-space'. The new function will
      also remove all white-space characters between the columns (not just
      white space characters at the start of the line). Thus the resulting
      check won't involve spacing between columns.

A common set of steps are always necessary to prepare a project for
publication. Until now, we would simply look at previous submissions and
try to follow them, but that was prone to errors and could cause
confusion. The internal infrastructure also didn't have some useful
features to make good publication possible. Now that the submission of a
paper fully devoted to the founding criteria of Maneage is complete
(arXiv:2006.03018), it was time to formalize the necessary steps for easier
submission of a project using Maneage and implement some low-level features
that can make things easier.

With this commit a first draft of the publication checklist has been added
to 'README-hacking.md', it was tested in the submission of arXiv:2006.03018
and zenodo.3872248. To help guide users on implementing the good practices
for output datasets, the outputs of the default project shown in the paper
now use the new features). After reading the checklist, please inspect
these.

Some other relevant changes in this commit:

  - The publication involves a copy of the necessary software
    tarballs. Hence a new target ('dist-software') was also added to
    package all the project's software tarballs in one tarball for easy
    distribution.

  - A new 'dist-lzip' target has been defined for those who want to
    distribute an Lzip-compressed tarball.

  - The '\includetikz' LaTeX macro now has a second argument to allow
    configuring the '\includegraphics' call when the plot should not be
    built, but just imported.

1 files changed, 18 insertions, 7 deletions

diff --git a/tex/src/preamble-pgfplots.tex b/tex/src/preamble-pgfplots.tex
index af6cb8d..1d57daf 100644
--- a/tex/src/preamble-pgfplots.tex
+++ b/tex/src/preamble-pgfplots.tex
@@ -77,17 +77,28 @@
 
 
 
-%% The following rule will cause the name of the files keeping a figure's
-%% external PDF to be set based on the file that the TiKZ commands are
-%% from. Without this, TiKZ will use numbers based on the order of
-%% figures. These numbers can be hard to manage and they will also depend
-%% on order in the final PDF, so it will be very buggy to manage them.
-\newcommand{\includetikz}[1]{%
+%% The '\includetikz' can be used to either build the figures using
+%% PGFPlots (when '\makepdf' is defined), or use an existing file (when
+%% '\makepdf' isn't defined). When making the PDF, it will set the output
+%% figure name to be the same as the 'tex/src/XXXX.tex' file that contains
+%% the PGFPlots source of the figure. In this way, when using the PDF, it
+%% will also have the same name, thus allowing the figures to easily change
+%% their place relative to others: figure ordering won't be a problem. This
+%% is a problem by default because if an explicit name isn't set at the
+%% start, tikz will make images based on their order in the paper.
+%
+%% This function takes two arguments:
+%%     1) The base-name of the LaTeX file with the 'tikzpicture'
+%%        environment. As mentioned above, this will also be the name of
+%%        the produced figure.
+%%     2) The settings to use with 'includegraphics' when an already-built
+%%        file should be used.
+\newcommand{\includetikz}[2]{%
   \ifdefined\makepdf%
     \tikzsetnextfilename{#1}%
     \input{tex/src/#1.tex}%
   \else
-    \includegraphics[width=\linewidth]{tex/tikz/#1.pdf}
+    \includegraphics[#2]{tex/tikz/#1.pdf}
   \fi
 }