diff --git a/README.md b/README.md index 04f11dc..09489d3 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,33 @@ -# latex-common - -Repository containing common latex code that can be shared across multiple projects. - -## Usage - -Put - -```latex -\input{common.tex} -``` - -in your preamble. See the `examples` folder for usage examples. - -## Build examples - -### Build manually - -```bash -$ latexmk example.tex -``` - -### Build using docker - -1. Build docker image - ```bash - $ docker build -f dockerfile/Dockerfile.alpine . -t latex-common - ``` -2. Build example - ```bash - $ docker run --rm -v $PWD:$PWD -w $PWD `id -u`:`id -g` latex-common latexmk example.tex - ``` - +# latex-common + +Repository containing common latex code that can be shared across multiple projects. + +## Usage + +Put + +```latex +\input{common.tex} +``` + +in your preamble. See the `examples` folder for usage examples. + +## Build examples + +### Build manually + +```bash +$ latexmk example.tex +``` + +### Build using docker + +1. Build docker image + ```bash + $ docker build -f dockerfiles/Dockerfile.alpine . -t latex-common + ``` +2. Build example + ```bash + $ docker run --rm -v $PWD:$PWD -w $PWD `id -u`:`id -g` latex-common latexmk example.tex + ``` +