aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDave Gauer <dave@ratfactor.com>2021-02-12 20:49:57 -0500
committerDave Gauer <dave@ratfactor.com>2021-02-12 20:49:57 -0500
commit79a2feec39239b289720310571f2cb4b0d454bde (patch)
treea1c3fb90e224a5106a79bf9cade4ae02215a3d68 /README.md
parentdd64f828333d4c6b6a5335d88d0903b0d591178c (diff)
parent971ab7f49836dc21b8f7d6fbed4320e37d503697 (diff)
downloadziglings-79a2feec39239b289720310571f2cb4b0d454bde.tar.gz
ziglings-79a2feec39239b289720310571f2cb4b0d454bde.tar.bz2
ziglings-79a2feec39239b289720310571f2cb4b0d454bde.tar.xz
ziglings-79a2feec39239b289720310571f2cb4b0d454bde.zip
Merge branch 'zig-build' of https://github.com/SpexGuy/ziglings into SpexGuy-zig-build
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 19 insertions, 5 deletions
diff --git a/README.md b/README.md
index 69287dd..f560284 100644
--- a/README.md
+++ b/README.md
@@ -43,20 +43,35 @@ git clone https://github.com/ratfactor/ziglings
cd ziglings
```
-Then run the `ziglings` script and follow the instructions to begin!
+Then run `zig build` and follow the instructions to begin!
```bash
-./ziglings
+zig build
```
## Manual Usage
-If you can't (or don't want to) use the script, you can manually verify each
-exercise with the Zig compiler:
+If you want to run a single file for testing, you can do so with this command:
```bash
zig run exercises/01_hello.zig
```
+or, alternatively
+```bash
+zig build 01_test
+```
+
+To verify a single file, use
+
+```bash
+zig build 01_only
+```
+
+To prepare an executable for debugging, install it to zig-cache/bin with
+
+```bash
+zig build 01_install
+```
## TODO
@@ -66,7 +81,6 @@ the learning resource I wished for. There will be tons of room for improvement:
* Wording of explanations
* Idiomatic usage of Zig
* Additional exercises
-* Re-write the `ziglings` script using the Zig build system (or just a Zig application)
Planned exercises: