Add README

2024-08-29 11:53:08 -05:00 · 2024-08-29 11:53:08 -05:00 · fee04030e6
parent 515814ed04
commit fee04030e6
1 changed files with 30 additions and 0 deletions
--- a/30
+++ b/30
@ -0,0 +1,30 @@
+nnote: nora's notes
+----
+
+provides four notemaking scripts: dnote, mnote, ynote, gnote
+
+installation
+----
+set $NOTESDIR or use ~/Notes
+clone this repo to ~NOTESDIR/bin
+symlink dnote, mnote, ynote, gnote to your path like
+
+$ ln -s "$NOTESDIR/bin/dnote" "$HOME/.bin/dnote"
+
+usage
+----
+
+use dnote for daily notes, mnote for monthly, ynote for yearly, gnote for global
+you can enter different names but by default those are the note names too
+the file hierarchy is very simple, for instance:
+- $NOTESDIR
+  - bin/
+    - [scripts]
+  - [global notes]
+  - 2024/
+    - [yearly notes]
+    - 08/
+      - [monthly notes]
+      - 28/
+        - [daily notes]
+