From 0f36dee9ed3225662e551fce165e30867b246656 Mon Sep 17 00:00:00 2001 From: Marc Coquand Date: Fri, 17 May 2024 14:25:52 -0500 Subject: updates --- README | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) (limited to 'README') diff --git a/README b/README index aa89a21..09ad900 100644 --- a/README +++ b/README @@ -82,8 +82,8 @@ _________________ 1.5 DEVELOPMENT ~~~~~~~~~~~~~~~ - To set up the project, 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,9 +95,15 @@ _________________ dune exec -- stitch --help=groff - To prepare for release, run + 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. - dune build --profile release + 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 @@ -110,6 +116,7 @@ _________________ - Support command pipign and hotkeys - Line wrapping - Support URL shortening. + - Better result narrowing 2 KNOWN ISSUES -- cgit v1.2.3