From 3c664571a43883b0fb3d38ef9141183403a3ed0d Mon Sep 17 00:00:00 2001 From: Ander Punnar Date: Wed, 15 Mar 2023 22:04:06 +0200 Subject: [PATCH] update README --- README.md | 32 +++++++++++++++++++++++--------- 1 file changed, 23 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 42a67e209..b32f93828 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,30 @@ # skonfig extra set -This is a set of extra types for use with the [skonfig](https://skonfig.li) configuration management system. +[skonfig](https://skonfig.li) is a configuration management system forked from [cdist](https://cdi.st) +(after [e250024](https://code.ungleich.ch/ungleich-public/cdist/commit/e2500248f2ddc83129e77f2e6b8dffb64904dbae)). -Work is mostly split between three main repositories: +We have three main repositories: * [skonfig](https://github.com/skonfig/skonfig) - implementation of the **skonfig tool** and quick **getting started** bits, -* [base](https://github.com/skonfig/base) - **base** explorers and types, -* **extra** - **extra** types (community contributions). +* [base](https://github.com/skonfig/base) - explorer and types for **general use**, +* **extra** - **special purpose** types and incubator for new types. -## base vs extra? +You can find us in `#skonfig:matrix.org` ([matrix?](https://matrix.org/faq/)). -Explorers and types which are related to changing state of the operating -system or core components of it and are not strictly related to some specific -piece of software, are considered base. -Furthermore, the quality requirements for inclusion in base are higher than for extra. +## Documentation + +Most parts of [cdist documentation](https://www.cdi.st/manual/latest/) apply, but there are differences: + +* `skonfig` does only `config` (see `skonfig -h`), +* some types behave differently and it's recommended to consult manuals in *base* and *extra*. + +## Split between *base* and *extra* + +**Base** explorers and types are used to change the state of the operating +system or core components of it and are not for some specific piece of +software. Furthermore, the quality requirements for inclusion in base are +higher than for extra. + +**Extra** contains types for specific purposes like configuring software or +services which don't belong to the operating system and also serves as an +incubator for new types.