commit d658ac6284717ce4742174f4431a5059ec5ce876 parent eb0066767f250256f3e10812eb46ec22b115c64d Author: amin <dev@aminmesbah.com> Date: Tue, 25 Jun 2019 00:53:59 +0000 Add a readme with build instructions FossilOrigin-Name: 6881eab5d22e827c1f6f7d1b14b7093796505d481d0cce868738da5f2fee563e Diffstat:
| A | README.md | | | 32 | ++++++++++++++++++++++++++++++++ |
1 file changed, 32 insertions(+), 0 deletions(-)
diff --git a/README.md 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