stitch

Note taking for messy minimalists

commit 51be86b41d8c61228330fe13fbdb47c5c2030336
parent 5618ab3a4109a0f962b8554d497d6400406b7b4b
Author: Marc Coquand <marc@mccd.space>
Date:   Sun, 19 May 2024 15:17:50 -0500

Update manpages

Diffstat:
M
bin/main.ml
 | 
35
++++++++++++++++++-----------------

1 file changed, 18 insertions(+), 17 deletions(-)
diff --git a/bin/main.ml b/bin/main.ml
@@ -87,10 +87,11 @@ let headlines_cmd =
     ; `P "To get started, start by setting up a note directory in your shell profile"
     ; `Pre "export STITCH_DIRECTORY=/home/bob/notes"
     ; `P
-        "Stitch does not specify anything on how to capture your notes, but you can add \
-         the following in your profile to have a basic note capturing system."
+        "Stitch does not specify anything on how to capture your notes, but you can \
+         install the following shell script to your $PATH to have a basic note capturing \
+         system."
     ; `Pre
-        "function capture {\n\
+        "  #!/bin/sh\n\
         \  JRNL=\"\\$STITCH_DIRECTORY/\\$(date +'%y-%m-%d.%H:%M.%S').org\"\n\
         \  echo '*  ' > /tmp/capture  \n\
         \  \\$EDITOR /tmp/capture +1\n\
@@ -100,11 +101,11 @@ let headlines_cmd =
         \  else \n\
         \     echo \"Storing capture in \\$JRNL\"\n\
         \     cat /tmp/capture > \\$JRNL\n\
-        \  fi\n\
-         }"
+        \  fi"
     ; `P
         "Now you can run capture in your terminal and it will prompt you to write your \
-         note and store it in your notes with a timestamp."
+         note and store it in your notes with a timestamp. You can also capture within \
+         stitch, by running !capture"
     ; `P
         "With that, you can begin to capture your notes and they will be displayed in \
          reverse chronological order in stitch. You can add tags, for example :journal: \
@@ -118,10 +119,10 @@ let headlines_cmd =
          see all commands with '?'"
     ; `P "You can also launch stitch without arguments to see all."
     ; `P
-        "To set up TODO capturing, you can add a command todo to your shell profile to \
-         capture TODO items"
+        "To set up TODO capturing, you can add a command shell script todo to your PATH \
+         to capture TODO items"
     ; `Pre
-        "function todo {\n\
+        "  #!/bin/sh\n\
         \  TODO_BASE='* TODO  '\n\
         \  JRNL=\"\\$STITCH_DIRECTORY/\\$(date +'%y-%m-%d.%H:%M.%S').org\"\n\
         \  echo '* TODO  ' > /tmp/capture\n\
@@ -132,23 +133,23 @@ let headlines_cmd =
         \  else \n\
         \     echo \"Storing capture in \\$JRNL\"\n\
         \     cat /tmp/capture > \\$JRNL\n\
-        \  fi\n\
-         }"
+        \  fi"
     ; `P
-        "After that, you can capture a few TODO items, and you will be able to view them \
-         if you press 2. You can see done items if you press 3. Press '?' to see how to \
-         toggle the todo items."
+        "After that, you can capture a few TODO items by running todo in your terminal \
+         or !todo in stitch, and you will be able to view them if you press 2. You can \
+         see done items if you press 3. Press '?' to see how to toggle the todo items."
     ]
   in
   let commands =
     [ `S "COMMAND SUBSTITUTION"
     ; `P ""
     ; `P
-        "You can run arbitrary shell commands in Stitch. These commands can make use of the \
-         variable substitutions below."
+        "You can run arbitrary shell commands in Stitch. These commands can make use of \
+         the variable substitutions below."
     ; `I ("%(file)", "Currently selected file")
     ; `I ("%(line)", "Currently selected content")
-    ; `P "For example, if you select a line and run !rm %(file), it will remove that file."
+    ; `P
+        "For example, if you select a line and run !rm %(file), it will remove that file."
     ]
   in
   let credit =