README: How to run a test instance

README.md

@@ -11,7 +11,7 @@ The Owl was written by Martin Mareš <mj@ucw.cz>.
 
 ## License
 
-The whole package is (c) 2020-2024 Martin Mareš.
+The whole package is (c) 2020-2025 Martin Mareš.
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Affero General Public License as
@@ -34,3 +34,20 @@ Owl's repository contains embedded copies of several libraries:
 
   - Swagger in `static/swagger/`, which is an official release obtained
     from https://github.com/swagger-api/swagger-ui/.
+
+
+## Running a test instance
+
+First of all, install PostgreSQL, create a user and a database and initialize
+the database using db/db.ddl.
+
+Then copy etc/config.py.example to owl/config.py and edit parameters of the
+database connection.
+
+Create a Python virtual environment, activate it and run "pip install -e .".
+
+Create a user with administrator rights using "bin/flask create-user --admin ...".
+
+Run the web application using "bin/flask run".
+
+Create more users and courses using sub-commands of bin/flask ("--help" works).