diff options
| -rw-r--r-- | README.md | 25 |
1 files changed, 11 insertions, 14 deletions
@@ -18,6 +18,11 @@ command on your browser, and download the project's source (there is a button to download a compressed tarball of the project). If you have received this source from arXiv, please see the respective section below. +IMPORTANT NOTE: If you want to build using a distributed tarball that isn't +under Git's version control, see the points below under building project +tarball, a few minor modifications need to be made before starting the +project configuration and build. + ```shell $ git clone https://gitlab.com/makhlaghi/maneage-paper $ cd maneage-paper @@ -83,12 +88,16 @@ requiring root/administrator permissions. -### Source from arXiv +### Building project tarball (possibly from arXiv) If the paper is also published on arXiv, it is highly likely that the authors also uploaded/published the full project there along with the LaTeX sources. If you have downloaded (or plan to download) this source from -arXiv, some minor extra steps are necessary: +arXiv, some minor extra steps are necessary as listed below. This is +because this tarball is mainly tailored to automatic creation of the final +PDF without actually using the './project' command! You can directly run +'latex' on this directory and the paper will be built with no analysis (all +necessary built products are already included). 1. If the arXiv code for the paper is 1234.56789, then the downloaded source will be called `1234.56789` (no special identification @@ -136,18 +145,6 @@ arXiv, some minor extra steps are necessary: variable value to `tikz/`, so it looks like this: `\tikzsetexternalprefix{tikz/}`. -5. In order to let arXiv build the LaTeX paper without bothering to run the - analysis pipeline it was necessary to create and fill the two - `tex/build` and `tex/tikz` subdirectories. But to do a clean build of - the project, it is necessary for these to be symbolic links to the build - directory. So when you are first configuring the project, run it with - `--clean-texdir` (only once is enough, they will be deleted permanently - after that), for example: - - ```shell - $ ./project configure --clean-texdir - ``` - |