stitch

Note taking for messy minimalists

commit 2b47b301cbf234eabfcebd28f069e5d154441354
parent e10ed4b5f489023f3e5c50606aae33eb0211d4e0
Author: Marc Coquand <marc@mccd.space>
Date:   Mon, 13 May 2024 13:22:47 -0500

test a org based readme

Diffstat:
D
README
 | 
76
----------------------------------------------------------------------------
A
README.org
 | 
80
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
D
bin/.#main.ml
 | 
2
--
M
cgitrc
 | 
3
++-

4 files changed, 82 insertions(+), 79 deletions(-)
diff --git a/README b/README
@@ -1,76 +0,0 @@
-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 does not have any opinion about which file 
-format you use for file capturing, use org, markdown, whatever you
-want. You can customize the grep command.
-
-Stitch limits itself only to note composing. For capturing notes, you
-will have to set up your own system. 
-
-AIMS
-
-- Single binary
-- Minimal
-- 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.
-
-Set the environment variables:
-
-STICH_DIRECTORY
-STICH_GREP_CMD (default "grep")
-STITCH_HEADLINE_PATTERN (default "^\* ")
-STITCH_TAG_PATTERN (default ":[a-z]:")
-
-SPEED UP
-
-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.
-
-DEVELOPMENT
-
-To set up the project, easiest way is to just install Nix, direnv and
-enable nix flakes. Then to compile:
-
-dune build
-
-And to run:
-
-dune exec -- stitch
-
-
-RECIPES
-
-Building a journaling system
----
-
-You can build a basic capture command using $EDITOR and date command:
-
-alias capture="JRNL=\"$STITCH_DIRECTORY/$(date +'%Y-%m-%d %H:%M').org\" echo '* :journal:' > $JRNL_FILE && $EDITOR $JRNL_FILE 
-
-and then you can find your journal entries, automatically sorted by creation date with
-stitch and the journal tag:
-
-alias jrnl="stitch -t journal"
-
-LICENSE
-
-License is BSD-3-Clause
-
-KNOWN ISSUES
-
-- Resizing the screen when editor is open causes panic
-
-
-
diff --git a/README.org b/README.org
@@ -0,0 +1,80 @@
+* 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 does not have any opinion about which file format you use for
+file capturing, use org, markdown, whatever you want. You can
+customize the grep command.
+
+Stitch limits itself only to note composing. For capturing notes, you
+will have to set up your own system.
+
+** AIMS
+
+- Single binary
+- Minimal
+- 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.
+
+Set the environment variables:
+
+STICH_DIRECTORY
+STICH_GREP_CMD (default "grep")
+STITCH_HEADLINE_PATTERN (default "^\* ")
+STITCH_TAG_PATTERN (default ":[a-z]:")
+
+** SPEED UP
+
+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.
+
+** DEVELOPMENT
+
+To set up the project, easiest way is to just install Nix, direnv and
+enable nix flakes. Then to compile:
+
+dune build
+
+And to run:
+
+dune exec -- stitch
+
+
+** RECIPES
+
+- Building a journaling system
+You can build a basic capture command using $EDITOR and date command:
+
+alias capture="JRNL=\"$STITCH_DIRECTORY/$(date +'%Y-%m-%d
+%H:%M').org\" echo '* :journal:' > $JRNL_FILE && $EDITOR $JRNL_FILE
+
+and then you can find your journal entries, automatically sorted by
+creation date with stitch and the journal tag:
+
+alias jrnl="stitch -t journal"
+* KNOWN ISSUES
+
+- Resizing the screen when editor is open causes panic
+
+
+* Author
+
+Marc Coquand, 2024
+
+* LICENSE
+
+BSD-3-Clause
+
+
+
+
diff --git a/bin/.#main.ml b/bin/.#main.ml
@@ -1 +0,0 @@
-mccd@void.21115:1715189760
-\ No newline at end of file
diff --git a/cgitrc b/cgitrc
@@ -1 +1 @@
-readme=README
+readme=:README
+\ No newline at end of file