add readme
This commit is contained in:
parent
2e1700152c
commit
f1ac9fb028
2
Makefile
2
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
|
||||
|
@ -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"
|
||||
|
21
readme.md
Normal file
21
readme.md
Normal file
@ -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
|
||||
```
|
Reference in New Issue
Block a user