alvierahman90/notes2web
Archived
1
1
Fork 0
Code Issues 5 Pull Requests Projects Releases Wiki Activity

add extra info to readme

Browse Source
This commit is contained in:
Akbar Rahman 2021-04-30 22:08:24 +01:00
parent e2f17c8367
commit efa6fd4b24
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
readme.md
View File

@ -4,9 +4,8 @@ View your notes as a static html site.
## Install
```
# make install
```
0. Install [Pandoc](https://pandoc.org/index.html)
1. Run `make install` as root
## Usage
@ -14,6 +13,12 @@ View your notes as a static html site.
notes2web NOTES_DIRECTORY_1 [NOTES_DIRECTORY_2 [...]]
```
The command will generate and place html files in your notes directory.
It will then generate a list of all note files and put it in `index.html` in the
root directory.
Then you just have to point a webserver at your notes directory.
## Uninstall
```