aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README15
1 files changed, 9 insertions, 6 deletions
diff --git a/README b/README
index 09ad900..3f7c386 100644
--- a/README
+++ b/README
@@ -82,8 +82,8 @@ _________________
1.5 DEVELOPMENT
~~~~~~~~~~~~~~~
- To set up the project for local development, easiest way is to just install Nix, direnv
- and enable nix flakes. Then to compile:
+ To set up the project for local development, easiest way is to
+ just install Nix, direnv and enable nix flakes. Then to compile:
dune build
@@ -95,17 +95,20 @@ _________________
dune exec -- stitch --help=groff
- To prepare for release, we need to statically link the binary, which unless you use a
- musl based distro it will not do out of the box.
+ To prepare for release, we need to statically link the binary, which
+ unless you use a musl based distro it will not do out of the box.
- There is a Dockerfile included that prepares the release, use it with podman:
+ There is a Dockerfile included that prepares the release, use it with
+ podman:
podman pull docker.io/alpine:edge
podman build . -t stitch:latest
mkdir release
podman run -v ./release:/tmp/build/_build:U stitch:latest
- Binary will be found in ./_build/default/bin/stitch
+ Binary will be found in ./release/install/default/bin/stitch and
+ manpages in ./release/install/default/man/man1/stitch.1
+
1.6 ROADMAP