From 14bb72bf0176e395723f31ad071480a3160e0130 Mon Sep 17 00:00:00 2001 From: Rutger Broekhoff Date: Fri, 21 May 2021 19:39:25 +0200 Subject: Add building instructions to README.md --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) 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! Contains a tool called `znk` which is a clone of the [`nk` tool](https://github.com/nats-io/nkeys/tree/master/nk). +## Building + +Zig master works at the time of writing. + +Use `zig build` to build (the library and the `znk` tool). + +The `znk` tool can be run by using `zig build run`. + +Tests for the library can be run by using `zig build test`. +Tests for the `znk` tool can be run by using `zig build znk-test`. + -- cgit v1.2.3