From b451b954eda06a20e4785e24856a7299fb11acd5 Mon Sep 17 00:00:00 2001 From: q3aql Date: Mon, 26 Apr 2021 20:53:40 +0200 Subject: [PATCH] README.md --- README.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..5e94683 --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ +Archive indexer (Bootstrap) - Create simple HTML/CSS page with indexed files. +============================================================================= + +# How to use: + + * **Available folders**: + + * **`files:`** For packages or applications. + * **`scripts:`** For text files or scripts. + * **`documents:`** For documents as ODT, PDF or DOCX. + + * **Steps**: + + * After depositing your different files in the mentioned folders, the next step is to run the indexer. + * If you use `Linux/Unix`: + + ```shell + chmod +x file-indexer.sh + ./file-indexer.sh + ```` + + * If you use `Windows`: + + ```shell + file-indexer.cmd + ```` + + * Finally, open the file **`index.html`** in your browser. + +_**Note**: Files must `not contain spaces`._ + +# Filters: + + * If you want certain packages to be indexed with custom descriptions, you will have to edit the following filters. + + * `Linux/Unix`: + + ```shell + - dark/filters.sh + - light/filters.sh + ```` + + * `Windows`: + + ```shell + - dark/filters.cmd + - light/filters.cmd + ```` + +# Images (Dark Theme & Light Theme): + + + + + +### External links: + + * [Bootstrap](https://getbootstrap.com/) + * [Ubuntu font Homepage](https://design.ubuntu.com/font/) + * [HTML 5 Homepage](https://html.com/html5/)