summaryrefslogtreecommitdiffhomepage
path: root/examples/README.md
diff options
context:
space:
mode:
authorRyan Roden-Corrent <[email protected]>2021-10-14 07:24:00 -0400
committerGitHub <[email protected]>2021-10-14 13:24:00 +0200
commit588131c9d526d6bf63ced0c9a95a660801a3d711 (patch)
tree203986c1d4edb7e3e741064fe6770f714fff9186 /examples/README.md
parent52c1a4e7d003f0be64b2e2eec27307f03b0f0727 (diff)
downloadraylib-588131c9d526d6bf63ced0c9a95a660801a3d711.tar.gz
raylib-588131c9d526d6bf63ced0c9a95a660801a3d711.zip
Add zig buildfile for examples. (#2051)
* Add zig buildfile for examples. - `zig build` to compile all examples - `zig build [module]` to compile all examples for a module (e.g. `zig build core`) - `zig build [example]` to compile _and run_ a particular example (e.g. `zig build core_basic_window`) You can use `-Dtarget=` to compile for a non-native platform, such as `zig build -Dtarget=x86_64-windows-gnu` to compile from Linux to Windows. * Skip pthread example on Windows. * Select appropriate lib file based on target.
Diffstat (limited to 'examples/README.md')
-rw-r--r--examples/README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/examples/README.md b/examples/README.md
index ddf69fe5..14d566b2 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -1,3 +1,21 @@
+## Building the Examples
+
+The examples assume you have already built the `raylib` library in `../src`.
+
+### With GNU make
+
+- `make` builds all examples
+- `make [module]` builds all examples for a particular module (e.g `make core`)
+
+### With Zig
+
+The [Zig](https://ziglang.org/) toolchain can compile `C` and `C++` in addition to `Zig`.
+You may find it easier to use than other toolchains, especially when it comes to cross-compiling.
+
+- `zig build` to compile all examples
+- `zig build [module]` to compile all examples for a module (e.g. `zig build core`)
+- `zig build [example]` to compile _and run_ a particular example (e.g. `zig build core_basic_window`)
+
## EXAMPLES LIST
### category: core