Update README.md
This commit is contained in:
parent
e141782b2b
commit
e3836db8d9
66
README.md
66
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
|
||||
```
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user