Public/TexCommons
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

improved markdown

Browse Source
This commit is contained in:
o-da 2023-05-14 13:45:36 +02:00
parent 6b8c7447b5
commit bdb96be5d0
1 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -8,22 +8,24 @@ Most importantly it contains the makefile with common command packages to compil
* Run `git submodule update --init` or `git submodule update --recursive` in `TexCommon` if it is empty * Run `git submodule update --init` or `git submodule update --recursive` in `TexCommon` if it is empty
* Use `git pull origin master` in `TexCommon` to update to the latest version * Use `git pull origin master` in `TexCommon` to update to the latest version
* Add the `Makefile` to your repository with the content * Add the `Makefile` to your repository with the content
``` ```
export TEXINPUTS:=${TEXINPUTS}:.:TexCommon export TEXINPUTS:=${TEXINPUTS}:.:TexCommon
SRCNAMES := <list of files to compile> SRCNAMES := <list of files to compile>
include TexCommon/Makefile include TexCommon/Makefile
``` ```
* If `SRCNAMES` is omitted, it will be computed automatically * If `SRCNAMES` is omitted, it will be computed automatically
## Quick summary of commands ## Quick summary of commands
- `make (=make pdf)` complies .pdf from the root file. * `make (=make pdf)` complies .pdf from the root file.
- `make <filename>` tries to obtain `<filename>`, e.g. if `<filename>=foo.pdf` it will try * `make <filename>` tries to obtain `<filename>`, e.g. if `<filename>=foo.pdf` it will try
to compile `foo.tex` in order to get it no matter what `foo` is. to compile `foo.tex` in order to get it no matter what `foo` is.
- `make clean` removes all target files obtained by latex in one round. * `make clean` removes all target files obtained by latex in one round.
- `make cleanall` removes all target files. * `make cleanall` removes all target files.
- `make up` uploads the compiled `.pdf` and `.ps` files on the server to the current user's directory under the same name unless overridden by `$EXTNAME` variable. * `make up` uploads the compiled `.pdf` and `.ps` files on the server to the current user's directory under the same name unless overridden by `$EXTNAME` variable.
- `make show` shows the compiled `.pdf` using `xdg-open`. * `make show` shows the compiled `.pdf` using `xdg-open`.
- `make bibtex` runs bibtex for all `.bib` files of the current directory. * `make bibtex` runs bibtex for all `.bib` files of the current directory.
- `make bibtool` normalizes the the `.bib` files by calling bibtool with the settings given in `bibtool.rc` * `make bibtool` normalizes the the `.bib` files by calling bibtool with the settings given in `bibtool.rc`
- `make pack` create a zipped file of a final version of the paper (usually needs manual postprocessing) * `make pack` create a zipped file of a final version of the paper (usually needs manual postprocessing)