summaryrefslogtreecommitdiffhomepage
path: root/projects/CMake/README.md
diff options
context:
space:
mode:
authorRob Loach <[email protected]>2022-01-10 02:55:32 -0500
committerGitHub <[email protected]>2022-01-10 08:55:32 +0100
commitc0da80c2b809a0dcec7af1bcf860d6fbb1a64292 (patch)
treeef249ad43244cd1ecebed3e52814bc9b8d0fc703 /projects/CMake/README.md
parenta6aa5a1e4c34e7d8dfbede6d17ee40f7648265bb (diff)
downloadraylib-c0da80c2b809a0dcec7af1bcf860d6fbb1a64292.tar.gz
raylib-c0da80c2b809a0dcec7af1bcf860d6fbb1a64292.zip
cmake: Update CMake project template with docs and web (#2274)
Diffstat (limited to 'projects/CMake/README.md')
-rw-r--r--projects/CMake/README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/projects/CMake/README.md b/projects/CMake/README.md
new file mode 100644
index 00000000..402d3170
--- /dev/null
+++ b/projects/CMake/README.md
@@ -0,0 +1,29 @@
+# raylib CMake Project
+
+This provides a base project template which builds with [CMake](https://cmake.org).
+
+## Usage
+
+To compile the example, use one of the following dependending on your build target...
+
+### Desktop
+
+Use the following to build for desktop:
+
+``` bash
+mkdir build
+cd build
+cmake ..
+make
+```
+
+### Web
+
+Compiling for the web requires the [Emscripten SDK](https://emscripten.org/docs/getting_started/downloads.html):
+
+``` bash
+mkdir build
+cd build
+emcmake cmake .. -DPLATFORM=Web -DCMAKE_BUILD_TYPE=Release -DCMAKE_EXE_LINKER_FLAGS="-s USE_GLFW=3" -DCMAKE_EXECUTABLE_SUFFIX=".html"
+emmake make
+``` \ No newline at end of file