aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README15
1 files changed, 7 insertions, 8 deletions
diff --git a/README b/README
index 577e373..f3106e9 100644
--- a/README
+++ b/README
@@ -31,24 +31,23 @@ officially supported.
To build:
-First install GLFW via your system package manager, or set the relevant
-environment variables to point the compiler towards your installation.
+First compile GLFW to a static library, and place it in the root directory of
+this project.
-Then, run these commands in the root directory of the repo:
+Then, just run the build script:
-$ cp config.def.mk config.mk
-$ make
+$ ./build.sh
It will output an executable called `demonchime', which you can then run. If
-desired, most compilation flags can be customized via config.mk
+desired, you can customize the build `via build.env'.
== Development ==
If you need to use a debugger or otherwise inspect the executable, you can
enable debug flags:
-$ make CONFIG=debug
+$ ./build.sh debug
If you want to immediately run the executable:
-$ make run
+$ ./build.sh run