add development instructions to README

README.md

@@ -4,10 +4,28 @@
 
 This repository contains the code for the EZ LAN Manager.
 
-## How to install [prod]
+## Development Setup
 
-TBD
+### Prerequisites
 
-## How to install [dev]
+- Working Installation of MySQL 5 or latest MariaDB Server (`mariadb-server` for Debian-based Linux, `XAMPP` for Windows)
+- Python 3.9 or higher
+- PyCharm or similar IDE (optional)
 
-TBD
+### Step 1: Preparing Database
+
+To prepare the database, apply the SQL file located in `sql/create_database.sql` to your database server. This is easily accomplished with the MYSQL Workbench, but it can be also done by pipeing the file into the mariadb-server executable.
+
+Optionally, you can now execute the script `create_demo_database_content.py`, found in `src/ez_lan_manager/helpers`. Be aware that it can be buggy sometimes, especially if you overwrite existing data.
+
+### Step 2: Preparing configuration
+
+Use the example configuration at `config/config.example.toml` to create a `config.toml` at the base of the repository. Most of the parameters do not matter to get the development setup done, but the database credentials need to be correct.
+
+### Step 3: Install dependecies
+
+Use `pip install -r requirements.txt` to install the requirements. The usage of a venv is recommended.
+
+### Step 4: Running the application
+
+Run the application by executing the file `EzLanManager.py` found at `src/ez_lan_manager`. Check the STDOUT for information regarding the port on which the application is now served.