aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLibravatar Rutger Broekhoff2021-05-21 19:39:25 +0200
committerLibravatar Rutger Broekhoff2021-05-21 19:39:25 +0200
commit14bb72bf0176e395723f31ad071480a3160e0130 (patch)
treea2fd9db9d9edad6977b17de9ce78d3853099f77a /README.md
parentd557182115e8e7428834c872af2b958bf91d4beb (diff)
downloadzig-nkeys-14bb72bf0176e395723f31ad071480a3160e0130.tar.gz
zig-nkeys-14bb72bf0176e395723f31ad071480a3160e0130.zip
Add building instructions to README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index a6ac3af..815b8f4 100644
--- a/README.md
+++ b/README.md
@@ -7,3 +7,14 @@ Still a work in progress, things will definitely change!
7 7
8Contains a tool called `znk` which is a clone of the [`nk` tool](https://github.com/nats-io/nkeys/tree/master/nk). 8Contains a tool called `znk` which is a clone of the [`nk` tool](https://github.com/nats-io/nkeys/tree/master/nk).
9 9
10## Building
11
12Zig master works at the time of writing.
13
14Use `zig build` to build (the library and the `znk` tool).
15
16The `znk` tool can be run by using `zig build run`.
17
18Tests for the library can be run by using `zig build test`.
19Tests for the `znk` tool can be run by using `zig build znk-test`.
20