summary refs log tree commit diff
path: root/misc/build_scripts/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'misc/build_scripts/readme.md')
-rw-r--r--misc/build_scripts/readme.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/misc/build_scripts/readme.md b/misc/build_scripts/readme.md
new file mode 100644
index 0000000..0ff1d43
--- /dev/null
+++ b/misc/build_scripts/readme.md
@@ -0,0 +1,9 @@
+This folder contains build scripts for automatically compiling ClassiCube
+
+|File|Description|
+|--------|-------|
+|buildbot.sh | Compiles the game to optimised executables (with icons) |
+|buildbot_plugin.sh | Compiles specified plugin for various platforms |
+|buildtestplugin.sh | Example script for how to use buildbot_plugin.sh  | 
+|makerelease.sh | Packages the executables to produce files for a release |
+|notify.py | Notifies a user on Discord if buildbot fails |
\ No newline at end of file