From fc8ca19aa1e09a0e6e7433acc23473def7169c6d Mon Sep 17 00:00:00 2001 From: Eliot Berriot <contact@eliotberriot.com> Date: Tue, 14 May 2019 09:22:29 +0200 Subject: [PATCH] Added philosophy / tests instructions --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 7e3185f..65cf620 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,18 @@ Using this role, you can install and upgrade a Funkwhale pod, closely matching o - Install and configure Funkwhale and it's dependencies - Install and configure a SSL certificate with Let's Encrypt (optional) +Philosophy +---------- + +This role strives to: + +- Work out-of-the box by default +- Be modular and lightweight +- Avoid dependencies on other ansible roles +- Allow further customization +- Allow running multiple Funkwhale instances on the same host +- Avoid messing with existing software and apps on the server + Installation and usage ---------------------- @@ -139,6 +151,12 @@ Dependencies This roles has no other dependencies. +Tests +----- + +This role is tested using [molecule](https://molecule.readthedocs.io/en/stable/). +We don't have CI yet, but you can run the tests with `molecule test`. + Todo ---- -- GitLab