aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorMarc Coquand <marc@mccd.space>2024-05-17 14:25:52 -0500
committerMarc Coquand <marc@mccd.space>2024-05-17 14:25:52 -0500
commit0f36dee9ed3225662e551fce165e30867b246656 (patch)
tree31d0c65bb6374ba4f9fb04c39c413242e202dd82 /README
parent12c6b55e7c1d53122ca73f2a8d0067d10060f0be (diff)
downloadstitch-0f36dee9ed3225662e551fce165e30867b246656.tar.gz
stitch-0f36dee9ed3225662e551fce165e30867b246656.tar.bz2
stitch-0f36dee9ed3225662e551fce165e30867b246656.zip
updates
Diffstat (limited to 'README')
-rw-r--r--README15
1 files changed, 11 insertions, 4 deletions
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