Update README.md

This commit is contained in:
an.tsouchlos 2023-12-21 01:55:45 +00:00
parent e141782b2b
commit e3836db8d9

View File

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