Add basic README

2023-09-02 21:24:36 +02:00 · 2023-09-02 21:24:36 +02:00 · 024cf6c1d8
commit 024cf6c1d8
parent 6089cc8179
1 changed files with 29 additions and 1 deletions
--- a/README.md
+++ b/README.md
@ -1 +1,29 @@
-# website
+<a href="https://www.offen.dev/">
+    <img src="https://offen.github.io/press-kit/offen-material/gfx-GitHub-Offen-logo.svg" alt="Offen logo" title="Offen" width="150px"/>
+</a>
+
+# Website
+
+## The www.offen.software website
+
+This repository contains the source code for the <https://www.offen.software> website.
+
+---
+
+### Developing the application
+
+The development setup requires `docker` and `docker compose` to be installed.
+
+After cloning the repository, you can build the containers and install dependencies using:
+
+```sh
+$ make setup
+```
+
+You can test your setup by starting the application:
+
+```sh
+$ make up
+```
+
+which should enable you to access the homepage at <http://localhost:9001/>.