Skip to content

Commit c0d73c8

Browse files
committed
adjust README, drop matrix, add IRC (welcome back, old man)
1 parent 4744d55 commit c0d73c8

1 file changed

Lines changed: 4 additions & 33 deletions

File tree

README.md

Lines changed: 4 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -2,43 +2,14 @@
22

33
[skonfig](https://skonfig.li) is a system configuration and automation framework
44
designed to work with all systems, from your toaster to the data centre.
5+
All you need is an SSH connection and a POSIX/UNIX-like shell environment.
6+
And best of all: you already know how to use it (if you know shell scripts).
57

6-
skonfig uses three main repositories:
8+
skonfig has three main repositories:
79

810
* [skonfig](https://github.com/skonfig/skonfig) - implementation of the **skonfig** executable,
9-
* **base** - explorer and types for **general use**,
11+
* [base](https://github.com/skonfig/base) - explorer and types for **general use**,
1012
* [extra](https://github.com/skonfig/extra) - **special purpose** types and incubator for new types.
1113

1214
Check out the [skonfig](https://github.com/skonfig/skonfig) repository to learn
1315
how to get started.
14-
15-
**Need support?** You can find us in `#skonfig:matrix.org` ([matrix?](https://matrix.org/faq/)).
16-
17-
## Documentation
18-
19-
Most parts of the [cdist documentation](https://www.cdi.st/manual/latest/) still
20-
apply, but there are some differences:
21-
22-
* `skonfig` does only `config` (see `skonfig -h`),
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*.
28-
29-
## What are *base* and *extra*?
30-
31-
**Base** explorers and types are used to change the state of the operating
32-
system or core components of it and are not for some specific piece of
33-
software. Furthermore, the quality requirements for inclusion in base are
34-
higher than for extra.
35-
36-
**Extra** contains types for specific purposes like configuring software or
37-
services which don't belong to the operating system and also serves as an
38-
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://cdi.st/) originally, your cdist manifests
44-
and types will continue to work with skonfig with no or minimal adjustments.

0 commit comments

Comments
 (0)