updating readme for new run and build process
This commit is contained in:
39
README.md
39
README.md
@@ -10,24 +10,31 @@ This is a library system for the different facilities in our university. Because
|
||||
|
||||
### Installation
|
||||
#### Windows
|
||||
using the latest git commit version:
|
||||
```
|
||||
git clone https://git.theprivateserver.de/WorldTeacher/LibrarySystem.git
|
||||
cd LibrarySystem
|
||||
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
|
||||
```
|
||||
For windows, there are two ways to install the software:
|
||||
|
||||
1. using the latest git commit version:
|
||||
|
||||
~~or head over to [releases](https://git.theprivateserver.de/WorldTeacher/LibrarySystem/releases)
|
||||
and download the latest version~~ (not yet supported)
|
||||
Prerequisites:
|
||||
- [uv](https://docs.astral.sh/uv/getting-started/installation/) and [Git](https://git-scm.com/downloads/win) are installed
|
||||
|
||||
```bash
|
||||
git clone https://git.theprivateserver.de/WorldTeacher/LibrarySystem.git
|
||||
cd LibrarySystem
|
||||
uv sync # This will install all dependencies, including dev dependencies
|
||||
source venv/Scrpits/activate(.bat|ps1) # This will activate the virtual environment
|
||||
uv run python main.py
|
||||
```
|
||||
|
||||
building the software:
|
||||
```bash
|
||||
uv run python build.py
|
||||
```
|
||||
This will create a build folder with the application in it. You can move the folder of the application anywhere you want
|
||||
|
||||
2. using the release:
|
||||
|
||||
~~see: [releases](https://git.theprivateserver.de/WorldTeacher/LibrarySystem/releases)
|
||||
and download the latest version~~ (not yet supported)
|
||||
|
||||
|
||||
### Configuration
|
||||
|
||||
Reference in New Issue
Block a user