niansa/descindex
1
0
Fork 0
mirror of https://gitlab.com/niansa/descindex.git synced 2025-03-06 20:48:44 +01:00
Code Releases Activity

Added building instructions to readme

Browse source
This commit is contained in:
niansa 2023-02-11 17:32:50 +00:00
parent f4959e47a9
commit 2e018dac07
1 changed files with 9 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -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.