diff --git a/README.md b/README.md index 9aec617..f08b21b 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,35 @@ # munta +Munta is your locally hosted one-stop-shop for all your audio and pictures conversion needs. It is a containerized web frontend for `ffmpeg`. It is aimed at supporting only libre codecs. Some handy filters (like vignette for pictures and echo for audio) are also available through the conversion process. + +## Setup + +1. Clone this repository: + +``` +git clone https://forge.slowte.ch/selfhosted/munta.git +``` + +2. Build the container using the provided `Dockerfile`: + +``` +cd munta +docker build -t munta . +``` + +3. Run the freshly built container: + +``` +docker run -p 8080:80 munta +``` + +4. Open your internet browser, go to `127.0.0.1:8080` and enjoy! + ## Licenses -_munta_ uses [_Pico CSS_ `v1.5.10`][picocss-release], a Minimal CSS Framework for semantic HTML. +_munta_ bundles the following programs: -_Pico CSS_ is published under the MIT license, reproduced below. +- [_Pico CSS_ `v1.5.10`][picocss-release], a minimal CSS framework for semantic HTML. It is published under the MIT license, reproduced below. > MIT License >