summaryrefslogtreecommitdiff
path: root/FETCH_DEPS.md
diff options
context:
space:
mode:
Diffstat (limited to 'FETCH_DEPS.md')
-rw-r--r--FETCH_DEPS.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/FETCH_DEPS.md b/FETCH_DEPS.md
new file mode 100644
index 0000000..d16fb45
--- /dev/null
+++ b/FETCH_DEPS.md
@@ -0,0 +1,32 @@
+# Fetching Third-Party Dependencies
+
+This project intentionally does NOT vendor large third-party libraries.
+
+Currently required:
+
+## miniaudio
+
+Single-header audio library.
+
+Source:
+https://github.com/mackron/miniaudio
+
+Required file:
+- miniaudio.h
+
+Expected location:
+third_party/miniaudio.h
+
+### Automatic fetch
+
+Use one of the provided scripts:
+- scripts/project_init.sh
+- scripts/project_init.bat
+
+### Manual fetch
+
+Download miniaudio.h from:
+https://raw.githubusercontent.com/mackron/miniaudio/master/miniaudio.h
+
+and place it into:
+third_party/miniaudio.h