test a org based readme

1 files changed, 28 insertions, 24 deletions

diff --git a/README b/README.org
index 7af7768..14ae9cd 100644
--- a/README
+++ b/README.org
@@ -1,28 +1,28 @@
-Stitch - Note Composer
+* 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 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 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. 
+will have to set up your own system.
 
-AIMS
+** AIMS
 
 - Single binary
 - Minimal
 - Work with any file format
 
-CREDIT
+** CREDIT
 
 Stitch is based and largely a stripped down copy of the note composing
 system of Howm for Emacs.
 
-INSTALLATION
+** INSTALLATION
 
 Chmod +x the binary and put in PATH.
 
@@ -33,12 +33,12 @@ STICH_GREP_CMD (default "grep")
 STITCH_HEADLINE_PATTERN (default "^\* ")
 STITCH_TAG_PATTERN (default ":[a-z]:")
 
-SPEED UP
+** 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
+** DEVELOPMENT
 
 To set up the project, easiest way is to just install Nix, direnv and
 enable nix flakes. Then to compile:
@@ -50,27 +50,31 @@ And to run:
 dune exec -- stitch
 
 
-RECIPES
-
-Building a journaling system
----
+** 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 
+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:
+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
 
-LICENSE
+- Resizing the screen when editor is open causes panic
 
-License is BSD-3-Clause
 
-KNOWN ISSUES
+* Author
+
+Marc Coquand, 2024
+
+* LICENSE
+
+BSD-3-Clause
 
-- Resizing the screen when editor is open causes panic