aboutsummaryrefslogtreecommitdiff
path: root/project
diff options
context:
space:
mode:
authorMohammad Akhlaghi <mohammad@akhlaghi.org>2019-09-16 00:55:07 +0100
committerMohammad Akhlaghi <mohammad@akhlaghi.org>2019-09-16 01:06:05 +0100
commitc88950e788e17f8213330624b0d44c83344c2f1e (patch)
tree64b890db11a5d7cbdc8cfbd1dd0fe904f457f283 /project
parent403ec7d7c632ae410ee2052bfc0a5f52aa05e466 (diff)
Distribution tarball now builds in arXiv
`./project make dist' will package all the LaTeX-specific files (and analysis source files) into one `tar.gz' file that is ready to upload to servers like arXiv. However, it wasn't updated for some time, so running it would complain about not having a `configure' script in the top of the project. With this commit, it now works with the new file-structure of the project and also copies all the BibLaTeX source files and `paper.bbl' into the top tarball directory, which allows arXiv to build the paper as intended. The output of `./project make dist' has been uploaded and tested on arXiv and it is built by arXiv perfectly. Also, a short description of all the special `make' targets was added to the output of `./project --help'.
Diffstat (limited to 'project')
-rwxr-xr-xproject31
1 files changed, 20 insertions, 11 deletions
diff --git a/project b/project
index c60bba1..e7f44a8 100755
--- a/project
+++ b/project
@@ -72,23 +72,32 @@ RECOMMENDATION: If this is the first time you are configuring this
template, please don't use the options and let the script explain each
parameter in full detail by simply running './project configure'.
-With the options below you can modify the default behavior.
+Project 'make' special features.
+ ./project make Build the project on one thread
+ ./project make -jN Built the project in parallel on N threads.
+ ./project make clean Clean all files generated by 'make' (not software).
+ ./project make distclean Clean everything (including compiled software).
+ ./project make dist Produce a LaTeX-ready-to-build distribution tarball
+ ('tar.gz') of the project. This is ready to be
+ uploaded to servers like 'arXiv.org'.
+ ./project make dist-zip Similar to 'dist', but compress with '.zip'.
+With the options below you can modify the default behavior.
Configure options:
- -b, --build-dir=STR Top directory to build the project in.
- -e, --existing-conf Use (possibly existing) local configuration.
- --host-cc Use host system's C compiler, don't build GCC.
- -i, --input-dir=STR Directory containing input datasets (optional).
- -m, --minmapsize=INT [Gnuastro] Minimum number of bytes to use RAM.
- -s, --software-dir=STR Directory containing necessary software tarballs.
+ -b, --build-dir=STR Top directory to build the project in.
+ -e, --existing-conf Use (possibly existing) local configuration.
+ --host-cc Use host system's C compiler, don't build GCC.
+ -i, --input-dir=STR Directory containing input datasets (optional).
+ -m, --minmapsize=INT [Gnuastro] Minimum number of bytes to use RAM.
+ -s, --software-dir=STR Directory containing necessary software tarballs.
Configure and Make options:
- -g, --group=STR Build and run with write permissions for a group.
- -j, --jobs=INT Number of threads to build/run the software.
- -?, --help Print this help list.
+ -g, --group=STR Build and run with write permissions for a group.
+ -j, --jobs=INT Number of threads to build/run the software.
+ -?, --help Print this help list.
Make options:
- -d, --debug=FLAGS Print various types of debugging information.
+ -d, --debug=FLAGS Print various types of debugging information.
Mandatory or optional arguments to long options are also mandatory or optional
for any corresponding short options.