Skip to content

Commit 6f2ca30

Browse files
authored
Merge pull request skonfig#145 from riiengineering/update-readme
Update README.md
2 parents 435f00d + 7150fbe commit 6f2ca30

File tree

1 file changed

+22
-8
lines changed

1 file changed

+22
-8
lines changed

README.md

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,32 @@
11
# skonfig base set
22

3-
[skonfig](https://skonfig.li) is a configuration management system forked from [cdist](https://cdi.st)
4-
(after [e250024](https://code.ungleich.ch/ungleich-public/cdist/commit/e2500248f2ddc83129e77f2e6b8dffb64904dbae)).
3+
[skonfig](https://skonfig.li) is a system configuration and automation framework
4+
designed to work with all systems, from your toaster to the data centre.
55

6-
We have three main repositories:
6+
skonfig uses three main repositories:
77

8-
* [skonfig](https://github.com/skonfig/skonfig) - implementation of the **skonfig tool** and quick **getting started** bits,
8+
* [skonfig](https://github.com/skonfig/skonfig) - implementation of the **skonfig** executable,
99
* **base** - explorer and types for **general use**,
1010
* [extra](https://github.com/skonfig/extra) - **special purpose** types and incubator for new types.
1111

12-
You can find us in `#skonfig:matrix.org` ([matrix?](https://matrix.org/faq/)).
12+
Check out the [skonfig](https://github.com/skonfig/skonfig) repository to learn
13+
how to get started.
14+
15+
**Need support?** You can find us in `#skonfig:matrix.org` ([matrix?](https://matrix.org/faq/)).
1316

1417
## Documentation
1518

16-
Most parts of [cdist documentation](https://www.cdi.st/manual/latest/) apply, but there are differences:
19+
Most parts of the [cdist documentation](https://www.cdi.st/manual/latest/) still
20+
apply, but there are some differences:
1721

1822
* `skonfig` does only `config` (see `skonfig -h`),
19-
* some types behave differently and it's recommended to consult manuals in *base* and *extra*.
23+
* types are managed in sets (like this one),
24+
* type manifests can be a directory of scripts,
25+
* `gencode-*` can be a directory of scripts,
26+
* some types behave differently and it's recommended to consult the `man.rst`
27+
files in *base* and *extra*.
2028

21-
## Split between *base* and *extra*
29+
## What are *base* and *extra*?
2230

2331
**Base** explorers and types are used to change the state of the operating
2432
system or core components of it and are not for some specific piece of
@@ -28,3 +36,9 @@ higher than for extra.
2836
**Extra** contains types for specific purposes like configuring software or
2937
services which don't belong to the operating system and also serves as an
3038
incubator for new types.
39+
40+
Even more types can be found in sets specialised in helping you configure a
41+
specific piece of software. Some of these sets can be found in this organization.
42+
43+
And being a fork of [cdist](https://cdis.st/) originally, your cdist manifests
44+
and types will continue to work with skonfig with no or minimal adjustments.

0 commit comments

Comments
 (0)