diff --git a/README.md b/README.md index 7e51924..2f31cfe 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,18 @@ # DescIndex **D**escriptive **I**ndex generator +## Building + +To build this application, just either run `make` in the source dir or use CMake. + ## How to use Well it's really simple: For every file you have, add a file with equal name + `.txt` appended and fill it like this: This is the title - This is a description. - It's multi-line! + This is a multi-line + description! -Also, put a file named `desc.txt` with the same syntax into each folder. It's what describes the folder itself. +Also place a file named `desc.txt` with the same syntax in each folder. It's what describes the folder itself. + +Then, pass the root folder to the application and it'll create `index.html` files.