update readme, attributions
This commit is contained in:
34
README.md
34
README.md
@@ -1,30 +1,36 @@
|
||||
# LibrarySystem
|
||||
|
||||
universal library system for facilities in the university
|
||||
universal library system for facilities in the university. Currently hard-coded for the Library of the University of Education in Freiburg, Germany.
|
||||
|
||||
Other Libraries can be supported by rewriting the catalog and it's corresponding functions.
|
||||
|
||||
## 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.
|
||||
This is a library system for the different facilities in our 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
|
||||
### Installation
|
||||
#### Windows
|
||||
using the latest git commit version:
|
||||
```
|
||||
git clone https://git.theprivateserver.de/WorldTeacher/LibrarySystem.git
|
||||
cd LibrarySystem
|
||||
./build(.exe)
|
||||
python -m venv venv
|
||||
source venv/bin/activate
|
||||
pip install -r requirements.txt
|
||||
python main.py
|
||||
```
|
||||
building the software:
|
||||
```
|
||||
download the installer.bat
|
||||
execute the file in a terminal
|
||||
```
|
||||
|
||||
or head over to [releases](https://git.theprivateserver.de/WorldTeacher/LibrarySystem/releases)
|
||||
and download the latest version
|
||||
|
||||
~~or head over to [releases](https://git.theprivateserver.de/WorldTeacher/LibrarySystem/releases)
|
||||
and download the latest version~~ (not yet supported)
|
||||
|
||||
|
||||
### 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
|
||||
By default, the software will use the installation directory for all files, but you can change that in the config file, or using the settings window in the software.
|
||||
Reference in New Issue
Block a user