From 456324a035fa46b13379b9f3111eae6b73ec8f19 Mon Sep 17 00:00:00 2001
From: Collin Williams <96917990+bluedragon1221@users.noreply.github.com>
Date: Sat, 26 Oct 2024 15:25:44 -0500
Subject: add writeups of the build process and how the repo works

---
 BUILDING.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 BUILDING.md

(limited to 'BUILDING.md')

diff --git a/BUILDING.md b/BUILDING.md
new file mode 100644
index 0000000..d39e5c5
--- /dev/null
+++ b/BUILDING.md
@@ -0,0 +1,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)_
-- 
cgit v1.3.1