mirror of
https://gitlab.com/niansa/descindex.git
synced 2025-03-06 20:48:44 +01:00
Add README.md
This commit is contained in:
parent
dbfd80a781
commit
db61ad9276
1 changed files with 12 additions and 0 deletions
12
README.md
Normal file
12
README.md
Normal file
|
@ -0,0 +1,12 @@
|
|||
# DescIndex
|
||||
**D**escriptive **I**ndex generator
|
||||
|
||||
## 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!
|
||||
|
||||
Also, put a file named `desc.txt` into each folder. It's what describes the folder itself.
|
Loading…
Add table
Reference in a new issue