modify readme

This commit is contained in:
calm-steam 2025-02-19 00:49:39 +05:30
parent 2e114fef44
commit 6d002d74ae
Signed by: calm-steam
SSH Key Fingerprint: SHA256:VrjxFRfRdJ0oc+FjTdi2wneFAslmWVg6/r6Z773npjE

View File

@ -1,17 +1,23 @@
# GibCasa GameServerSupervisor
## Table of Contents
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Installation using venv](#installation_venv)
- [Prerequisites](#prerequisites1)
- [Installation](#installation1)
- [Installation using Podman](#installation_podman)
- [Prerequisites](#prerequisites2)
- [Installation](#installation2)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
## Prerequisites
## Installation using venv
### Prerequisites
Python 3.10 or above
## Installation
### Installation
1. Clone the repository:
```bash
@ -45,6 +51,46 @@ Python 3.10 or above
```bash
./manage.py runserver
```
## Installation using Podman
### Prerequisites
Podman
### Installation
1. Clone the repository:
```bash
git clone https://git.com.de/GibCasa/GameServerSupervisor
```
2. Build the image:
```bash
podman build . -t supervisor-image
```
3. Run a container in an interactive shell:
```bash
podman run -it --network=host localhost/supervisor-image sh
```
4. Install dependencies:
```bash
pip install -r requirements.txt
```
5. Run tests:
```bash
./manage.py test
```
6. Run migrations:
```bash
./manage.py migrate
```
7. Create admin user:
```bash
./manage.py createsuperuser
```
8. Run server:
```bash
./manage.py runserver
```
## Usage