From 6b8c7447b5119c0e58ba328ba033f1670eacea5f Mon Sep 17 00:00:00 2001 From: o-da Date: Sat, 13 May 2023 20:42:01 +0200 Subject: [PATCH] Updated README --- README.md | 37 +++++++++++++++++++++++-------------- 1 file changed, 23 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 036c022..0455128 100644 --- a/README.md +++ b/README.md @@ -2,19 +2,28 @@ The idea of this directory is to provide shared resources for preparing publicat Most importantly it contains the makefile with common command packages to compile latex files. -In order to use it, create a makefile in your directory with the same name with the only content. -'include /Makefile'. If your directory contains more than one root latex file -add 'SRCNAME=' before the include command. +## Usage -== Quick summary of commands == +* Add a submodule to your git repository with `git submodule add git@git8.cs.fau.de:public-repos/TexCommon.git` or `/public-repos/TexCommon.git` +* 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 +* Add the `Makefile` to your repository with the content +``` + export TEXINPUTS:=${TEXINPUTS}:.:TexCommon + SRCNAMES := + include TexCommon/Makefile +``` +* If `SRCNAMES` is omitted, it will be computed automatically -- make (=make pdf) - complies .pdf from the root file -- make - tries to achieve in a suitable way, e.g. if =foo.pdf it will try - 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 cleanall - removes all target files. -- make up - uploads the compiled .pdf and .ps files on the server to the current user's directory under t - same name unless overridden by $EXTNAME variable. -- make show - shows the compiled .dvi in xdvi -- 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 +## Quick summary of commands + +- `make (=make pdf)` complies .pdf from the root file. +- `make ` tries to obtain ``, e.g. if `=foo.pdf` it will try + 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 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 show` shows the compiled `.pdf` using `xdg-open`. +- `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 pack` create a zipped file of a final version of the paper (usually needs manual postprocessing)