aboutsummaryrefslogtreecommitdiff
path: root/BUILDING.md
blob: d39e5c564b9fea7a7e17d06251f32e0906b72333 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# Building this Project

For a quick-and-dirty build, just run `make all`.
To specify the directory to build into, you can pass in BUILD_DIR, e.g. `make BUILD_DIR=../_build all`.

Although the project is quite fast to build, we support [parallel execution](https://www.gnu.org/software/make/manual/html_node/Parallel.html).
This means you can pass the `-j` flag followed by the number of cores to compile markdown files in parallel.

## Git Build (for maintainers)
This is my general process:
```bash
export BUILD_DIR=$(mktemp -d)
make all

git checkout build
cp -r $BUILD_DIR/* .

git add .
git commit -m "build: $(date)"
git push

unset BUILD_DIR
```

_(CI/CD is scary, so I avoid it)_