From efa6fd4b2490efbed6835214e40907f4e3514be9 Mon Sep 17 00:00:00 2001
From: Alvie Rahman <alvierahman90@gmail.com>
Date: Fri, 30 Apr 2021 22:08:24 +0100
Subject: [PATCH] add extra info to readme

---
 readme.md | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)

diff --git a/readme.md b/readme.md
index 45e218d..20b1850 100644
--- a/readme.md
+++ b/readme.md
@@ -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
 
 ```