diff options
author | Mohammad Akhlaghi <mohammad@akhlaghi.org> | 2018-02-27 10:42:20 +0100 |
---|---|---|
committer | Mohammad Akhlaghi <mohammad@akhlaghi.org> | 2018-02-27 10:42:20 +0100 |
commit | 4360fbd36203022fde68b12f90548ca3a39085ce (patch) | |
tree | 9050a6a21743f7ccac2591e1e86d0043d13d68c7 /README.md | |
parent | c47486ccbf291c6e06df803f9abcdfcb6af5ca66 (diff) |
Copyrights and TeX management made more clear
Until now, the copyright statement was left empty for the users of the
pipeline to fill. However, the files have already been created and have an
author (or contributing authors) before the user starts using the
pipeline. So the original authors of the files are added along with the
year. The user can add their own name to the existing files under the
"Contributing author" when they start and they will be the "Original
author" of the new files they create.
Several changes were also made to the TeX management:
- LaTeX is run within a `reproduce/build/tex/build' directory now. Not in
the top reproduction pipeline directory. This helps keep all the
auxiliary TeX files and directories in that directory and keep the top
reproduction pipeline directory clean. After the final PDF is built, a
copy is put in the top reproduction pipeline directory for easy viewing.
- The PGFPlots preamble was also made more useful, allowing the name of
the `.tex' file to also be the name of the final plot that is
produced. This is a GREAT feature, because without it, the TiKZ
externalization would be based on order of the plots within the
paper. But now, order is irrelevant and we can even delete the TiKZ
files within the processing workhorse-Makefiles so the plots are
definitly rebuilt on the next run.
- The paper is now in a two-column format to be more similar to published
papers.
A tip on debugging Make was added to `README.md'.
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 17 |
1 files changed, 13 insertions, 4 deletions
@@ -314,10 +314,10 @@ been explained here), please let us know to correct it. ``` - **Copyright**, **name** and **date**: Go over the following files and - correct the copyright, names and dates in their first few lines: - `configure`, `Makefile` and `reproduce/src/make/*.mk`. When making new - files, always remember to add a similar copyright statement at the top - of the tile. + add your name and email to the copyright notice: `configure`, + `Makefile` and `reproduce/src/make/*.mk`. When making new files, + always remember to add a similar copyright statement at the top of the + file. - **Title**, **short description** and **author** of project: In this raw skeleton, the title or short description of your project should be @@ -551,6 +551,15 @@ us. In this way, we can add it here for the benefit of others. $ info make "automatic variables ``` + - *Debug*: Since Make doesn't follow the common top-down paradigm, it + can be a little hard to get accustomed to why you get an error or + un-expected behavior. In such cases, run Make with the `-d` + option. With this option, Make prints a full list of exactly which + prerequisites are being checked for which targets. Looking + (patiently) through this output and searching for the faulty + file/step will clearly show you any mistake you might have made in + defining the targets or prerequisites. + - *Large files*: If you are dealing with very large files (thus having multiple copies of them for intermediate steps is not possible), one solution is the following strategy. Set a small plain text file as |