From 738a41d27b04b028426c5aa20ea8fcfebb548bbc Mon Sep 17 00:00:00 2001
From: Steffen Pohle <steffen@gulpe.de>
Date: Sun, 30 Jun 2024 16:56:33 +0200
Subject: [PATCH] some basic documentation

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/README.md b/README.md
index 8b13789..a538e99 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,23 @@
 
+# MiniWebCam
+this application will start a inbuild webserver serving an camera image from 
+the following devices:
+- V4L2 Devices
+- Local Image File
+- Local Script to Create Images
+
+## Configuration
+The configuration is loaded in the following order.
+- systemwide configuration file [/etc/miniwebcam.conf]
+- program parameters
+- user defined configurtion file defined in the program parameters
+
+## How to build and install
+Meson/Ninja is used for the build process.
+To compile and install the application run the following commands:
+'''
+meson setup build
+meson compile -C build
+meson install -C build
+'''
+