diff options
| -rw-r--r-- | README | 63 |
1 files changed, 38 insertions, 25 deletions
@@ -1,6 +1,3 @@ -MCCD - - Table of Contents _________________ @@ -11,8 +8,9 @@ _________________ .. 4. INSTALLATION .. 5. DEVELOPMENT .. 6. ROADMAP -2. KNOWN ISSUES -3. Author +2. COMMUNITY & CONTRIBUTING +3. KNOWN ISSUES +4. Author 1 Stitch - Note Composer @@ -32,33 +30,30 @@ _________________ 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. + 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 also - customize the grep command to speed up performance. It only requires - that each note is contained to one file + file capturing: use org, markdown, whatever you want. You can also + customize the grep command to speed up performance. Stitch only + requires that each note is contained to one file. - 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. + Stitch does not come with a capture system for notes, but it 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. - Stitch comes as a single static binary, but uses grep, sort, cut, find - to work. + Stitch uses grep, sort, cut, find under the hood to work. 1.1 FEATURES ~~~~~~~~~~~~ - - Single static binary (though it makes use of coreutils) - - 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 - + - Available as a single static binary + - No need for any DB, just files + - Unix-y & fast 1.2 CREDIT ~~~~~~~~~~ @@ -76,7 +71,16 @@ _________________ 1.4 INSTALLATION ~~~~~~~~~~~~~~~~ - Chmod +x the binary and put in PATH. + You can find all static releases tagged under + https://git.mccd.space/pub/stitch/refs/ + + Obs, the download link next to the tag is for the snapshot, you will have + to enter the link of the tag to find the download to the binary. + + Download the binary, chmod +x the binary and put in PATH. + + At minimum, you will need to set the environment variable + STITCH_DIRECTORY for it to work 1.5 DEVELOPMENT @@ -111,7 +115,6 @@ _________________ Binary will be found in ./release/install/default/bin/stitch and manpages in ./release/install/default/man/man1/stitch.1 - 1.6 ROADMAP @@ -119,13 +122,24 @@ _________________ - Support sort - Support tagging commands - - Support command pipign and hotkeys + - Support command piping and hotkeys - Line wrapping - Support URL shortening. - Better result narrowing -2 KNOWN ISSUES +2 COMMUNITY & CONTRIBUTING +========================== + + Patches, discussions, bug reports etc. can be sent to + ~marcc/stitch-general@lists.sr.ht. + + Feel free to share your setup, tips, and tricks etc. + + Archives can be found at + https://lists.sr.ht/~marcc/stitch-general + +3 KNOWN ISSUES ============== - ugrep doesn't correctly handle ordering, meaning that if you sort by @@ -139,8 +153,7 @@ _________________ - The binary file is kinda big, 5mb. I'd love to slim it down. - -3 Author +4 Author ======== Marc Coquand (<https://mccd.space>) |