diff options
| author | Marc Coquand <marc@mccd.space> | 2024-05-16 10:33:52 -0500 |
|---|---|---|
| committer | Marc Coquand <marc@mccd.space> | 2024-05-16 10:33:52 -0500 |
| commit | eaf9162bad594040fbabc169f9b96757689528a4 (patch) | |
| tree | d07d5324f549300176d8270611a389832a49a67c | |
| parent | 8fa52e443773e386bfd2e2f78a561c07ed94772c (diff) | |
| download | stitch-eaf9162bad594040fbabc169f9b96757689528a4.tar.gz stitch-eaf9162bad594040fbabc169f9b96757689528a4.tar.bz2 stitch-eaf9162bad594040fbabc169f9b96757689528a4.zip | |
Update README
| -rw-r--r-- | README.org | 13 | ||||
| -rw-r--r-- | bin/main.ml | 1 |
2 files changed, 12 insertions, 2 deletions
@@ -8,11 +8,15 @@ 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. +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. + ** FEATURES - Single binary -- Minimal & fast -- UNIXy +- No need for any DB, just files +- UNIXy & fast - Work with any file format ** CREDIT @@ -42,6 +46,11 @@ To generate man pages, run dune exec -- stitch --help=groff +** ROADMAP + +- Support sort +- Support easy tagging + * KNOWN ISSUES - ugrep doesn't correctly handle ordering, meaning that if you sort by diff --git a/bin/main.ml b/bin/main.ml index 1708f13..79addc1 100644 --- a/bin/main.ml +++ b/bin/main.ml @@ -74,6 +74,7 @@ let headlines_cmd = "To set up, you will need to set STITCH_DIRECTORY (SEE ENVIRONMENT) at minimum. \ Stitch does not come with any built-in note-capturing tool, but you can easily \ set one up on your own (SEE EXAMPLES)." + ; `P "Stitch currently only works with a system where you have one file per note." ; `P "When you enter the program for the first time, press '?' to see the list of \ keybindings." |