aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README21
1 files changed, 18 insertions, 3 deletions
diff --git a/README b/README
index 350fd3a..aa89a21 100644
--- a/README
+++ b/README
@@ -37,17 +37,21 @@ _________________
Stitch does not have any opinion about which file format you use for
file capturing, use org, markdown, whatever you want. You can also
- customize the grep command to speed up performance.
+ customize the grep command to speed up performance. It only requires
+ that each note is contained to one file
Stitch does not come with any note capturing system built in, but
instead makes it easy for you to set up your own system in with your
preferred editor. There is a basic example included in the manpages.
+ Stitch comes as a single static binary, but uses grep, sort, cut, find
+ to work.
+
1.1 FEATURES
~~~~~~~~~~~~
- - Single binary
+ - Single static binary (though it makes use of coreutils)
- No need for any DB, just files
- UNIXy & fast
- Work with any file format, markdown, ruby markup, org etc.
@@ -91,12 +95,21 @@ _________________
dune exec -- stitch --help=groff
+ To prepare for release, run
+
+ dune build --profile release
+
+ Binary will be found in ./_build/default/bin/stitch
+
1.6 ROADMAP
~~~~~~~~~~~
- Support sort
- - Support easy tagging
+ - Support tagging commands
+ - Support command pipign and hotkeys
+ - Line wrapping
+ - Support URL shortening.
2 KNOWN ISSUES
@@ -111,6 +124,8 @@ _________________
uniform file name that we can regexp (and also tweak). I am not sure
yet what's best.
+ - The binary file is kinda big, 5mb. I'd love to slim it down.
+
3 Author
========