diff options
Diffstat (limited to 'README.org')
| -rw-r--r-- | README.org | 81 |
1 files changed, 14 insertions, 67 deletions
@@ -1,50 +1,31 @@ * Stitch - Note Composer -Stitch is a minimal grep-based CLI tool for composing notes. It is -built around the idea of writing notes separately and then using tags -to compose these notes together. +Stitch is a minimal grep-based CLI tool for composing and viewing notes and +TODO notes. It is built around the idea of writing notes separately and +then using tags to compose these notes together. 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 tries to have few dependencies, and stick only to coreutils by -default - -Stitch limits itself only to note composing. For capturing notes, you -will have to set up your own system. - -** AIMS +** FEATURES - Single binary -- Minimal +- Minimal & fast +- UNIXy - Work with any file format ** CREDIT -Stitch is based and largely a stripped down copy of the note composing -system of Howm for Emacs. - -** INSTALLATION - -Chmod +x the binary and put in PATH. +Stitch is based on the note composing system Howm for Emacs. -Set the environment variables: +** USAGE -STICH_DIRECTORY -STICH_GREP_CMD (default "grep") -STITCH_HEADLINE_PATTERN_REGEXP (default "^\\* ") -STITCH_HEADLINE_PATTERN (default "* ") -STITCH_TAG_PATTERN (default ":[a-z-]+:", matches :a-tag:) -STITCH_TODO (default "* TODO") -STITCH_TODO_REGEXP (default "^\\* TODO") -STITCH_DONE (default "* DONE") -STITCH_DONE_REGEXP (default "^\\* DONE") +Run ~stitch --help~ or ~man stitch~ for explanation and how to get started -** SPEED UP +** INSTALLATION -Stitch uses grep by default. As your notes grow, this will -become rather slow. To speed it up, you can replace it grep with ugrep. +Chmod +x the binary and put in PATH. ** DEVELOPMENT @@ -57,33 +38,9 @@ And to run: dune exec -- stitch +To generate man pages, run -** RECIPES - -- Building a journaling system -You can build a basic capture command using $EDITOR and date command: - -#+begin_src sh -export STITCH_DIRECTORY=/home/me/notes -function capture { - JRNL="$STITCH_DIRECTORY/$(date +'%y-%m-%d.%H:%M.%S').org" - echo '* :journal:' >> $JRNL - $EDITOR "$JRNL" +1:3 -} - -function todo { - JRNL="$STITCH_DIRECTORY/$(date +'%y-%m-%d.%H:%M.%S').org" - echo '* TODO ' >> $JRNL - kak "$JRNL" +1:8 -e "execute-keys i" -} - -alias jrnl='stitch -t :journal:' -#+end_src - -and then you can find your journal entries, automatically sorted by -creation date with stitch and the journal tag: - -alias jrnl="stitch -t journal" +dune exec -- stitch --help=groff * KNOWN ISSUES @@ -94,16 +51,6 @@ alias jrnl="stitch -t journal" One solution is to force one uniform file name that we can regexp (and also tweak). I am not sure yet what's best. - - * Author -Marc Coquand, 2024 - -* LICENSE - -BSD-3-Clause - - - - +Marc Coquand (https://mccd.space) |