From 3661ece211cd3bfe0f1ce60c27bd304cb0b60094 2023-08-04 15:27:44
From: x <xbr@c3l.lu>
Date: 2023-08-04 15:27:44
Subject: [PATCH] style: reformat main README

---

diff --git a/README.md b/README.md
index 1972b9b8147ce2b2fdf8ba3228f4c71e6ab5174b..34b30368536248c313181ba8f9969311207ae318 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,16 @@
-hosts file : Contains all your maschines. Be very carefull, a wrong defined maschine can lead to major proplems.
-files directory: contains templates for your playbooks.
-api : for api.freifunk.lu.
-firmware : for firmware.freifunk.lu.
-initial : for initial server setup.
-gatewaay : for fflux gateway setup.
+# fflux Ansible Configuration
+
+This repo contains Ansible configs for the Freifunk Lëtzebuerg infra.
+
+## Files
+
+- `hosts`: contains all of the machines.
+  - Careful: a wrongly defined machine can lead to major problems.
+
+## Directories
+
+- `files`: templates for various playbooks
+- `initial_server_setup`: initial server setup
+- `gateway`: Set up a fflux gateway
+- `api`: api.freifunk.lu
+- `firmware`: firmware.freifunk.lu