aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README32
1 files changed, 15 insertions, 17 deletions
diff --git a/README b/README
index 410a443..aaa87b4 100644
--- a/README
+++ b/README
@@ -28,24 +28,22 @@ _________________
- Garden of Forking Paths, Borges
Stitch is a minimal grep-based CLI note-managing system targeting those that
- want to easily capture notes and not spend time organizing them. Capture
- your notes with tags and use stitch to compose the notes together.
- Build your own knowledge base, journal, todo manager and more.
+ want to easily capture notes and not spend time organizing them. Use tags
+ to capture notes and then stitch them together. Build your own knowledge
+ base, journal, todo manager and more.
- Stitch aims to be unopinionated; use whatever editor and file format you
- want. It only requires that each file contains only one heading.
-
- While Stitch is a note-manager, it does not come with functionality for
- capturing notes. This allows you to allow you to set it up in your preferred
- way for your editor. The manpages come with an example to get you started.
+ Stitch is unopiniated; use whatever editor and file format you want. It
+ only requires that each file contains only one heading.
+ Stitch is a note-manager that tag teams seamlessly with your preferred
+ text editor. The manpages provi some examples to get you started.
1.1 FEATURES
~~~~~~~~~~~~
- Read your notes in multiple different ways
- Comes with four views: full, headlines, todo, done
- - Work with any file format: markdown, ruby markup, org etc.
+ - Compatible with any file format: markdown, ruby markup, org etc.
- Run shell commands on notes using sed, grep etc.
- Write notes in any editor: vim, kakoune... or even ed!
- Available as a single static binary
@@ -89,16 +87,16 @@ _________________
Obs, the download link next to the tag is for the snapshot, you will have
to open the link of the tag to find the download to the binary.
- At minimum, you will need to set the environment variable
- STITCH_DIRECTORY, which should be an absolute path to where you
- want to store your notes, for stitch to work.
+ For stitch to work, you will need to set the environment variable
+ STITCH_DIRECTORY, which should be an absolute path to where you want to
+ store your notes, for stitch to work.
1.6 DEVELOPMENT & BUILDING
~~~~~~~~~~~~~~~~~~~~~~~~~~
- To set up the project for local development, easiest way is to
- just install Nix, direnv and enable nix flakes. Then to compile:
+ To set up the project for local development, the easiest way is to
+ install Nix, direnv and enable nix flakes. Then to compile:
dune build
@@ -166,8 +164,8 @@ _________________
waiting with a sort functionality until I have come up wiht a decent
implementation.
- - File names can not contain :[0-9]:, since it's used to determine
- where the file starts and ends.
+ - File names cannot contain :[0-9]:, since it's used to determine
+ where the file starts and ends with grep.
4 AUTHOR