aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README16
1 files changed, 10 insertions, 6 deletions
diff --git a/README b/README
index d8d17f8..2fa6838 100644
--- a/README
+++ b/README
@@ -7,7 +7,7 @@ _________________
.. 3. CREDIT
.. 4. USAGE
.. 5. INSTALLATION
-.. 6. DEVELOPMENT
+.. 6. DEVELOPMENT & BUILDING
.. 7. ROADMAP
2. COMMUNITY & CONTRIBUTING
3. KNOWN ISSUES
@@ -88,17 +88,17 @@ _________________
You can find all static releases tagged under
https://git.mccd.space/pub/stitch/refs/
+ Download the binary, chmod +x the binary and put in PATH.
+
Obs, the download link next to the tag is for the snapshot, you will have
to open the link of the tag to find the download to the binary.
-
- Download the binary, chmod +x the binary and put in PATH.
At minimum, you will need to set the environment variable
STITCH_DIRECTORY for it to work.
-1.6 DEVELOPMENT
-~~~~~~~~~~~~~~~
+1.6 DEVELOPMENT & BUILDING
+~~~~~~~~~~~~~~~~~~~~~~~~~~
To set up the project for local development, easiest way is to
just install Nix, direnv and enable nix flakes. Then to compile:
@@ -109,7 +109,7 @@ _________________
dune build --profile release
- And to run:
+ And to run
dune exec -- stitch
@@ -117,6 +117,10 @@ _________________
dune exec -- stitch --help=groff
+ You can find the generated binary under
+ _build/default/bin/main.exe. Ignore the .exe, it's not a windows
+ binary.
+
When the system is built with Nix, it will be dynamically linked.
To build a static release, There is a Dockerfile included that