aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarc Coquand <marc@mccd.space>2024-05-13 13:22:47 -0500
committerMarc Coquand <marc@mccd.space>2024-05-13 13:22:47 -0500
commit2b47b301cbf234eabfcebd28f069e5d154441354 (patch)
tree8e8db72b2849df0ba77af3ec19d770c62a4eaf0f
parente10ed4b5f489023f3e5c50606aae33eb0211d4e0 (diff)
downloadstitch-2b47b301cbf234eabfcebd28f069e5d154441354.tar.gz
stitch-2b47b301cbf234eabfcebd28f069e5d154441354.tar.bz2
stitch-2b47b301cbf234eabfcebd28f069e5d154441354.zip
test a org based readme
-rw-r--r--README.org (renamed from README)52
l---------bin/.#main.ml1
-rw-r--r--cgitrc2
3 files changed, 29 insertions, 26 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
diff --git a/bin/.#main.ml b/bin/.#main.ml
deleted file mode 120000
index 5a91e42..0000000
--- a/bin/.#main.ml
+++ /dev/null
@@ -1 +0,0 @@
-mccd@void.21115:1715189760 \ No newline at end of file
diff --git a/cgitrc b/cgitrc
index aa9ad34..9220741 100644
--- a/cgitrc
+++ b/cgitrc
@@ -1 +1 @@
-readme=README
+readme=:README \ No newline at end of file