From 0bc0958e789847d3065f4d084a96117d62d18691 Mon Sep 17 00:00:00 2001
From: Marc Coquand <marc@mccd.space>
Date: Tue, 14 May 2024 16:20:57 -0500
Subject: Add nice headings

---
 README.org | 22 ++++++++++++++++------
 1 file changed, 16 insertions(+), 6 deletions(-)

(limited to 'README.org')

diff --git a/README.org b/README.org
index 48e54c6..924a93f 100644
--- a/README.org
+++ b/README.org
@@ -5,8 +5,11 @@ 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.
+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.
@@ -30,7 +33,8 @@ Set the environment variables:
 
 STICH_DIRECTORY
 STICH_GREP_CMD (default "grep")
-STITCH_HEADLINE_PATTERN (default "^\\* ")
+STITCH_HEADLINE_PATTERN_REGEXP (default "^\\* ")
+STITCH_HEADLINE_PATTERN (default "* ")
 STITCH_TAG_PATTERN (default ":[a-z-]+:", matches :a-tag:)
 
 ** SPEED UP
@@ -55,8 +59,11 @@ dune exec -- stitch
 - 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"
+#+begin_src
+export STITCH_DIRECTORY=/home/me/notes
+
+alias capture="JRNL=\"$STITCH_DIRECTORY/$(date +'%Y-%m-%d %H:%M').org\" echo '* :journal:' > "$STITCH_DIRECTORY && $EDITOR $JRNL"
+#+end_src
 
 and then you can find your journal entries, automatically sorted by
 creation date with stitch and the journal tag:
@@ -65,7 +72,10 @@ alias jrnl="stitch -t journal"
 
 * KNOWN ISSUES
 
-- Resizing the screen when editor is open causes panic
+- ugrep doesn't correctly handle ordering, meaning that if you sort by
+  modified date, it doesn't behave correctly. Therefore, that behavior
+  is disabled for now.
+  
 
 
 * Author
-- 
cgit v1.2.3