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 +''' +