From 980411f42d514f712b7ea1f2f93e49af6e50d89c Mon Sep 17 00:00:00 2001 From: CJ van den Berg Date: Fri, 1 Mar 2024 16:04:00 +0100 Subject: [PATCH] Update README.md with better MacOS build instructions --- README.md | 32 ++++++++++++++++++++++++++------ 1 file changed, 26 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a6be73b..e20a78b 100644 --- a/README.md +++ b/README.md @@ -7,16 +7,26 @@ https://github.com/neurocyte/flow/assets/1552770/97aae817-c209-4c08-bc65-0a0bf1f # Building -Build with the provided zig wrapper: +Make sure your system meets the requirements listed below. + +Flow tracks zig master most of the time. Build with: + +```shell +zig build -Doptimize=ReleaseFast +``` + +Sometime zig master may introduce breaking changes and Flow may take a few days to +catch up. In that case there is a simple zig wrapper script provided that will download +and build with the last known compatible version of zig. The version is stored in +`build.zig.version`. + +Build with the zig wrapper: ```shell ./zig build -Doptimize=ReleaseFast ``` -The zig wrapper just fetches a known good version of zig nightly and places it -in the .cache directory. Or use your own version of zig. Be sure to use a version -at least as high as the version used be the zig wrapper. It's stored in `build.zig.version`. - -Also, make sure your system meets the requirements listed below. +The zig wrapper places the downloaded zig compiler in the `.cache` directory and does +not touch your system. It requires `bash`, `curl` and `jq` to run. Run with: ```shell @@ -27,6 +37,16 @@ Place it in your path for convenient access. See --help for full command line. +## MacOS + +On MacOS you will need to link Flow against a MacOS build of notcurses 3.0.9. This +is easiest with `brew`: + +```shell +brew install notcurses +zig build -Duse_system_notcurses=true --search-prefix /usr/local +``` + # Terminal configuration Kitty, Ghostty and most other terminals have default keybindings that conflict