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
========================

        "...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."
        - 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 (<https://mccd.space>)