From f1ac9fb028a73105c4c2c6013c491c81140c43fa Mon Sep 17 00:00:00 2001 From: Alvie Rahman Date: Fri, 30 Apr 2021 22:01:08 +0100 Subject: [PATCH] add readme --- Makefile | 2 +- notes2web | 2 +- readme.md | 21 +++++++++++++++++++++ 3 files changed, 23 insertions(+), 2 deletions(-) create mode 100644 readme.md diff --git a/Makefile b/Makefile index f0dece7..bea070a 100644 --- a/Makefile +++ b/Makefile @@ -4,5 +4,5 @@ install: cp -r templates /opt/notes2web cp styles.css /opt/notes2web -clean: +uninstall: rm -rf /usr/local/bin/notes2web/opt/notes2web diff --git a/notes2web b/notes2web index 541b00f..0da6a5f 100755 --- a/notes2web +++ b/notes2web @@ -1,6 +1,6 @@ #!/usr/bin/env bash -[[ -z "$1" ]] && echo "USAGE: $0 NOTES_DIRECTORY" && exit 0 +[[ -z "$1" ]] && echo "USAGE: $0 NOTES_DIRECTORY_1 [NOTES_DIRECTORY_2 [...]]" && exit 0 function _render { echo "rendering $1" diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..45e218d --- /dev/null +++ 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 +```