update readme
This commit is contained in:
27
README.md
27
README.md
@@ -1,3 +1,30 @@
|
|||||||
# LibrarySystem
|
# LibrarySystem
|
||||||
|
|
||||||
universal library system for facilities in the university
|
universal library system for facilities in the university
|
||||||
|
|
||||||
|
|
||||||
|
## What is this?
|
||||||
|
|
||||||
|
This is a library system for the different facilities in the university. Because some facilities lend their media, some wanted a software that allows them to keep track of who had what when.
|
||||||
|
|
||||||
|
### Installation
|
||||||
|
either clone the Repo
|
||||||
|
```
|
||||||
|
git clone https://git.theprivateserver.de/WorldTeacher/LibrarySystem.git
|
||||||
|
cd LibrarySystem
|
||||||
|
./build(.exe)
|
||||||
|
```
|
||||||
|
|
||||||
|
or head over to [releases](https://git.theprivateserver.de/WorldTeacher/LibrarySystem/releases)
|
||||||
|
and download the latest version
|
||||||
|
|
||||||
|
### Configuration
|
||||||
|
|
||||||
|
the software contains a config file in configs, as well as a config for icons, located in icons.
|
||||||
|
|
||||||
|
#### config
|
||||||
|
tbd
|
||||||
|
|
||||||
|
#### icons
|
||||||
|
- color is a value to re-paint the icons
|
||||||
|
- icons/* a dict of the icons structured like: icon_Name_in_Application : icon_File_name
|
||||||
Reference in New Issue
Block a user