aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README39
1 files changed, 26 insertions, 13 deletions
diff --git a/README b/README
index 8391502..6241326 100644
--- a/README
+++ b/README
@@ -3,11 +3,12 @@ _________________
1. Stitch - Note Composer
.. 1. FEATURES
-.. 2. CREDIT
-.. 3. USAGE
-.. 4. INSTALLATION
-.. 5. DEVELOPMENT
-.. 6. ROADMAP
+.. 2. SCREENSHOTS
+.. 3. CREDIT
+.. 4. USAGE
+.. 5. INSTALLATION
+.. 6. DEVELOPMENT
+.. 7. ROADMAP
2. COMMUNITY & CONTRIBUTING
3. KNOWN ISSUES
4. Author
@@ -41,8 +42,6 @@ _________________
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 uses grep, sort, cut, find under the hood to work.
-
1.1 FEATURES
~~~~~~~~~~~~
@@ -50,26 +49,40 @@ _________________
- Write your thoughs first, and organize later and read in multiple
different ways
- Work with any file format, markdown, ruby markup, org etc.
- - Work in any editor: vim, kakoune... or even ed!
+ - Run CLI commands on files (sed, grep etc.) with the command mode
+ - Write notes in any editor: vim, kakoune... or even ed!
- Available as a single static binary
- No need for any DB, just files
- Unix-y & fast
-1.2 CREDIT
+1.2 SCREENSHOTS
+~~~~~~~~~~~~
+
+ - Notes Overview + Search
+ https://blobs.mccd.space/stitch/notes-view.png
+ - TODO View
+ https://blobs.mccd.space/stitch/todo-view.png
+ - Done View (+ Example of a command)
+ https://blobs.mccd.space/stitch/done-view-commands.png
+ - Full-Notes View
+ https://blobs.mccd.space/stitch/full-notes-view.png
+
+
+1.3 CREDIT
~~~~~~~~~~
Stitch is based on the note composing system Howm for Emacs.
-1.3 USAGE
+1.4 USAGE
~~~~~~~~~
Run `stitch --help' or `man stitch' for explanation and how to get
started
-1.4 INSTALLATION
+1.5 INSTALLATION
~~~~~~~~~~~~~~~~
You can find all static releases tagged under
@@ -84,7 +97,7 @@ _________________
STITCH_DIRECTORY for it to work.
-1.5 DEVELOPMENT
+1.6 DEVELOPMENT
~~~~~~~~~~~~~~~
To set up the project for local development, easiest way is to
@@ -118,7 +131,7 @@ _________________
manpages in ./release/install/default/man/man1/stitch.1
-1.6 ROADMAP
+1.7 ROADMAP
~~~~~~~~~~~
- Support sort