add readme

2025-12-13 10:43:59 +00:00 · 2021-04-30 22:01:08 +01:00
parent 2e1700152c
commit f1ac9fb028
3 changed files with 23 additions and 2 deletions
--- a/readme.md
+++ b/readme.md
@@ -0,0 +1,21 @@
+# notes2web
+
+View your notes as a static html site.
+
+## Install
+
+```
+# make install
+```
+
+## Usage
+
+```
+notes2web NOTES_DIRECTORY_1 [NOTES_DIRECTORY_2 [...]]
+```
+
+## Uninstall
+
+```
+# make uninstall
+```