From cd7bf83a5c463c788de4126429ecf5e8146aabd2 Mon Sep 17 00:00:00 2001 From: Mohammad Akhlaghi Date: Wed, 1 Apr 2020 20:43:42 +0100 Subject: Added a README.md file under the top-level tex/ directory The subdirectories here (and the fact that they may be symbolic links) may be confusing for some early project users, so a `README.md' file was added there describing them and when they are links, when directories and when some may not yet exist. --- tex/README.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 tex/README.md (limited to 'tex') diff --git a/tex/README.md b/tex/README.md new file mode 100644 index 0000000..0f2f0d6 --- /dev/null +++ b/tex/README.md @@ -0,0 +1,59 @@ +Directory containing LaTeX-related files +---------------------------------------- + +Copyright (C) 2018-2020 Mohammad Akhlaghi \ +See the end of the file for license conditions. + +This directory contains directories to various components the LaTeX part of +the project. In a running project, it will contain the atleast the +following sub-directories. Note that + +- The `src/` directory contains the LaTeX files that are loaded into + `paper.tex`. This includes the necessary preambles, the LaTeX source + files to build tables or figures (for example with TiKZ or PGFPlots), and + etc. These files are under version-control and an integral part of the + project's source. + +- The `build/` directory contains all the built products (not source!) that + are created during the analysis and are necessary for building the + paper. This includes figures, plots, images, table source contents and + etc. Note that this directory is not under version control. + +- The `tikz/` directory is only relevant if some of the project's figures + are built with the LaTeX packages of TiKZ or PGFPlots. It points to the + directory containing the figures (in PDF) that were built by these tools. + Note that this directory is not under version control. + +The latter two directory and its contents are not under version control, so +if you have just cloned the project or are viewing its contents on a +browser, they don't exist. They will be created after the project is +configured for the running system. + +When the full project is build from scratch (building the software, +downloading necessary datasets, running the analysis and building the +paper's PDF), the latter two directories will be symbolic links to special +places under the Build directory. + +However, when the distributed tarball is used to only build the PDF paper +(without doing any analysis), the latter two directories will not be +symbolic links and will contain the necessary components for the paper to +be built. + + + + + +### Copyright information + +This project is free software: you can redistribute it and/or modify it +under the terms of the GNU General Public License as published by the Free +Software Foundation, either version 3 of the License, or (at your option) +any later version. + +This project is distributed in the hope that it will be useful, but WITHOUT +ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for +more details. + +You should have received a copy of the GNU General Public License along +with this project. If not, see . \ No newline at end of file -- cgit v1.2.1