image-index-py/README.md

13 lines
665 B
Markdown
Raw Normal View History

2022-11-16 10:36:34 +01:00
# image-index
This project is a collection of scripts which can index and sort files on your pc. You can give every file a title, category, source, tags and content for easier finding later on.
## Installation
```sh
$ git clone https://gitlab.com/rodin_schule/image-index-py.git
$ cd ./image-index-py
$ cp config-def.py config.py
```
## Configuration
The file `config.py` holds some very important variables which you need to look at before using the index:
* ROOT_DIR: The absolute path of where you want to save your files (the directories for the categories will be created there)
* CONFIG_DIR: The absolute path of where you want to store your `index.db`-file.