Update README.md
This commit is contained in:
parent
14b5bdac91
commit
6a0d1e4dc3
11
README.md
11
README.md
@ -1,6 +1,6 @@
|
|||||||
# ba-letter
|
# ba-letter
|
||||||
|
|
||||||
Repository containing latex source for the Bachelor's Thesis paper.
|
Repository containing the latex source for the bachelor's thesis letter.
|
||||||
|
|
||||||
After cloning, make sure to initialize the submodules containing the dependencies:
|
After cloning, make sure to initialize the submodules containing the dependencies:
|
||||||
```bash
|
```bash
|
||||||
@ -11,17 +11,24 @@ $ git submodule update --init
|
|||||||
|
|
||||||
### Build on host
|
### Build on host
|
||||||
|
|
||||||
|
For a list of dependencies consult one of the dockerfiles in the `dockerfiles` directory. Build document:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ make
|
$ make
|
||||||
```
|
```
|
||||||
|
|
||||||
|
After compiling, the PDF can be found in the `build` directory.
|
||||||
|
|
||||||
### Build using docker
|
### Build using docker
|
||||||
|
|
||||||
|
Be warned that `texlive` installations can take some time.
|
||||||
|
Building the docker image may take a few minutes.
|
||||||
|
|
||||||
1. Build docker image
|
1. Build docker image
|
||||||
```bash
|
```bash
|
||||||
$ docker build -f dockerfiles/Dockerfile.alpine . -t ba-letter
|
$ docker build -f dockerfiles/Dockerfile.alpine . -t ba-letter
|
||||||
```
|
```
|
||||||
2. Build examples
|
2. Build document
|
||||||
```bash
|
```bash
|
||||||
$ docker run --rm -v $PWD:$PWD -w $PWD -u `id -u`:`id -g` ba-letter make
|
$ docker run --rm -v $PWD:$PWD -w $PWD -u `id -u`:`id -g` ba-letter make
|
||||||
```
|
```
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user