From 27d323ac847bae378a4f4124b3496d3681b5b350 Mon Sep 17 00:00:00 2001 From: Alvie Rahman Date: Sat, 1 May 2021 13:39:34 +0100 Subject: [PATCH] update readme to reflect website put in own folder --- readme.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/readme.md b/readme.md index 095415d..0b15af7 100644 --- a/readme.md +++ b/readme.md @@ -21,11 +21,10 @@ 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. +The command will generate a website in the `$output` directory (`./web` by default). +It will then generate a list of all note files and put it in `index.html`. -Then you just have to point a webserver at your notes directory. +Then you just have to point a webserver at `$output`. ## Config