From 809d6e054833e0ded7ab8b5503b1f157169d1d8c Mon Sep 17 00:00:00 2001 From: Marc Coquand Date: Thu, 16 May 2024 11:36:34 -0500 Subject: Update README --- README | 124 ++++++++++++++++++++++++++++++++++++++++++++++++++++ README.org | 82 ---------------------------------- README.template.org | 85 +++++++++++++++++++++++++++++++++++ 3 files changed, 209 insertions(+), 82 deletions(-) create mode 100644 README delete mode 100644 README.org create mode 100644 README.template.org diff --git a/README b/README new file mode 100644 index 0000000..4b963d1 --- /dev/null +++ b/README @@ -0,0 +1,124 @@ +MCCD + + +Table of Contents +_________________ + +1. Stitch - Note Composer +.. 1. FEATURES +.. 2. CREDIT +.. 3. USAGE +.. 4. INSTALLATION +.. 5. DEVELOPMENT +.. 6. ROADMAP +2. KNOWN ISSUES +3. Author + + +1 Stitch - Note Composer +======================== + + "The explanation is obvious. The Garden of Forking Paths + is a picture, incomplete yet not false, of the universe + such as Ts'ui Pen conceived it to be. Differing from + Newton and Schopenhauer, your ancestor did not think of + time as absolute and uniform. He believed in an infinite + series of times, in a dizzily growing, ever spreading + network of diverging, converging and parallel times. This + web of time - the strands of which approach one another, + bifurcate, intersect or ignore each other through the + centuries - embraces every possibility. We do not exist in + most of them. In some you exist and not I, while in others + I do, and you do not, and in yet others both of us + exist. In this one, in which chance has favored me, you + have come to my gate. In another, you, crossing the + garden, have found me dead. In yet another, I say these + very same words, but am an error, a phantom." + - Garden of Forking Paths, Borges + + Stitch is a minimal grep-based CLI tool for composing and viewing + notes and TODO notes. It is built around the idea of writing notes + separately and then using tags to compose these notes together. In + that way building your own garden of forking paths. + + Stitch does not have any opinion about which file format you use for + file capturing, use org, markdown, whatever you want. You can also + customize the grep command to speed up performance. + + Stitch does not come with any note capturing system built in, but + instead makes it easy for you to set up your own system in with your + preferred editor. There is a basic example included in the manpages. + + +1.1 FEATURES +~~~~~~~~~~~~ + + - Single binary + - No need for any DB, just files + - UNIXy & fast + - Work with any file format, markdown, ruby markup, org etc. + - Work in any editor: vim, vi, ed, kakoune + - Write your thoughs first, and organize later and read in multiple + different ways + + +1.2 CREDIT +~~~~~~~~~~ + + Stitch is based on the note composing system Howm for Emacs. + + +1.3 USAGE +~~~~~~~~~ + + Run `stitch --help' or `man stitch' for explanation and how to get + started + + +1.4 INSTALLATION +~~~~~~~~~~~~~~~~ + + Chmod +x the binary and put in PATH. + + +1.5 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 + + To generate man pages, run + + dune exec -- stitch --help=groff + + +1.6 ROADMAP +~~~~~~~~~~~ + + - Support sort + - Support easy tagging + + +2 KNOWN ISSUES +============== + + - ugrep doesn't correctly handle ordering, meaning that if you sort by + modified date, it doesn't behave correctly. I've waited with + implementing it until I've resolved that issue + + - File names can not contain :[0-9]:, since it's used to determine + where the file starts and ends. One solution is to force one + uniform file name that we can regexp (and also tweak). I am not sure + yet what's best. + + +3 Author +======== + + Marc Coquand () diff --git a/README.org b/README.org deleted file mode 100644 index ccf6c48..0000000 --- a/README.org +++ /dev/null @@ -1,82 +0,0 @@ -* Stitch - Note Composer - -"The explanation is obvious. The Garden of Forking Paths is a picture, incomplete -yet not false, of the universe such as Ts'ui Pen conceived it to be. Differing from -Newton and Schopenhauer, your ancestor did not think of time as absolute and -uniform. He believed in an infinite series of times, in a dizzily growing, ever spreading -network of diverging, converging and parallel times. This web of time - the strands of -which approach one another, bifurcate, intersect or ignore each other through the -centuries - embraces every possibility. We do not exist in most of them. In some -you exist and not I, while in others I do, and you do not, and in yet others both of us -exist. In this one, in which chance has favored me, you have come to my gate. In -another, you, crossing the garden, have found me dead. In yet another, I say these -very same words, but am an error, a phantom." -- Garden of Forking Paths, Borges - -Stitch is a minimal grep-based CLI tool for composing and viewing notes and -TODO notes. It is built around the idea of writing notes separately and -then using tags to compose these notes together. In that way building your -own garden of forking paths. - -Stitch does not have any opinion about which file format you use for -file capturing, use org, markdown, whatever you want. You can also -customize the grep command to speed up performance. - -Stitch does not come with any note capturing system built in, but instead -makes it easy for you to set up your own system in with your preferred editor. -There is a basic example included in the manpages. - -** FEATURES - -- Single binary -- No need for any DB, just files -- UNIXy & fast -- Work with any file format, markdown, ruby markup, org etc. -- Work in any editor: vim, vi, ed, kakoune -- Write your thoughs first, and organize later and read in multiple different - ways - -** CREDIT - -Stitch is based on the note composing system Howm for Emacs. - -** USAGE - -Run ~stitch --help~ or ~man stitch~ for explanation and how to get started - -** INSTALLATION - -Chmod +x the binary and put in PATH. - -** 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 - -To generate man pages, run - -dune exec -- stitch --help=groff - -** ROADMAP - -- Support sort -- Support easy tagging - -* KNOWN ISSUES - -- ugrep doesn't correctly handle ordering, meaning that if you sort by - modified date, it doesn't behave correctly. I've waited with implementing it until I've resolved that issue - -- File names can not contain :[0-9]:, since it's used to determine where the file starts and ends. - One solution is to force one uniform file name that we can regexp (and also tweak). I am not sure yet what's - best. - -* Author - -Marc Coquand (https://mccd.space) diff --git a/README.template.org b/README.template.org new file mode 100644 index 0000000..7f1899a --- /dev/null +++ b/README.template.org @@ -0,0 +1,85 @@ +* Stitch - Note Composer + + +#+BEGIN_QUOTE +"The explanation is obvious. The Garden of Forking Paths is a picture, incomplete +yet not false, of the universe such as Ts'ui Pen conceived it to be. Differing from +Newton and Schopenhauer, your ancestor did not think of time as absolute and +uniform. He believed in an infinite series of times, in a dizzily growing, ever spreading +network of diverging, converging and parallel times. This web of time - the strands of +which approach one another, bifurcate, intersect or ignore each other through the +centuries - embraces every possibility. We do not exist in most of them. In some +you exist and not I, while in others I do, and you do not, and in yet others both of us +exist. In this one, in which chance has favored me, you have come to my gate. In +another, you, crossing the garden, have found me dead. In yet another, I say these +very same words, but am an error, a phantom." +- Garden of Forking Paths, Borges +#+END_QUOTE + +Stitch is a minimal grep-based CLI tool for composing and viewing notes and +TODO notes. It is built around the idea of writing notes separately and +then using tags to compose these notes together. In that way building your +own garden of forking paths. + +Stitch does not have any opinion about which file format you use for +file capturing, use org, markdown, whatever you want. You can also +customize the grep command to speed up performance. + +Stitch does not come with any note capturing system built in, but instead +makes it easy for you to set up your own system in with your preferred editor. +There is a basic example included in the manpages. + +** FEATURES + +- Single binary +- No need for any DB, just files +- UNIXy & fast +- Work with any file format, markdown, ruby markup, org etc. +- Work in any editor: vim, vi, ed, kakoune +- Write your thoughs first, and organize later and read in multiple different + ways + +** CREDIT + +Stitch is based on the note composing system Howm for Emacs. + +** USAGE + +Run ~stitch --help~ or ~man stitch~ for explanation and how to get started + +** INSTALLATION + +Chmod +x the binary and put in PATH. + +** 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 + +To generate man pages, run + +dune exec -- stitch --help=groff + +** ROADMAP + +- Support sort +- Support easy tagging + +* KNOWN ISSUES + +- ugrep doesn't correctly handle ordering, meaning that if you sort by + modified date, it doesn't behave correctly. I've waited with implementing it until I've resolved that issue + +- File names can not contain :[0-9]:, since it's used to determine where the file starts and ends. + One solution is to force one uniform file name that we can regexp (and also tweak). I am not sure yet what's + best. + +* Author + +Marc Coquand (https://mccd.space) -- cgit v1.2.3