aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAmin Mesbah <dev@aminmesbah.com>2019-06-24 17:53:59 -0700
committerAmin Mesbah <dev@aminmesbah.com>2019-06-24 17:53:59 -0700
commit15780ed658a7dc0f8f0bbc0f0d23af670d498415 (patch)
tree0ca248e8935b3b8f92d3831733d84f4bd1227c86
parenta5b87d33c4d3e21cd99f9c26cb74da0ae1c66cdc (diff)
downloadtransparent-cube-15780ed658a7dc0f8f0bbc0f0d23af670d498415.zip
transparent-cube-15780ed658a7dc0f8f0bbc0f0d23af670d498415.tar.gz
Add a readme with build instructions
-rw-r--r--README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9696249
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+### Compile on Linux
+
+- Install clang and glfw3 with your system's package manager.
+- `make run` to compile and run the release build.
+
+
+### Compile on Windows
+
+- Install and set up clang. The sanest set of instructions I've found is
+ [here][1].
+- Download the latest 64-bit Windows pre-compiled binary package from [here][2].
+- Unzip it and copy the `include` and `lib-vc2019` folders into
+ `lib/glfw_windows/`. The folder structure should look like this:
+
+```
+lib/glfw_windows/
+|-- include
+| +-- GLFW
+| |-- glfw3.h
+| +-- glfw3native.h
++-- lib-vc2019
+ |-- glfw3.dll
+ |-- glfw3dll.lib
+ +-- glfw3.lib
+```
+
+- `.\build.bat && .\out\release\transparent-cube.exe` to compile and run the
+ release build.
+
+
+ [1]: https://gist.github.com/InNoHurryToCode/955d63db0d79699fed63fe18eeebf17e
+ [2]: https://www.glfw.org/download.html