aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLaurent Bercot <ska-skaware@skarnet.org>2026-01-23 06:53:52 +0000
committerLaurent Bercot <ska-skaware@skarnet.org>2026-01-23 06:53:52 +0000
commit044e7a2b7975c0b4170f4c0d61ac2bdaee1873ea (patch)
tree807b3661660f8924f2167e9ad43586f55166e6d1
parent1aa3bc74170f10a4285827efa2748d1d6c2e4613 (diff)
downloads6-rc-044e7a2b7975c0b4170f4c0d61ac2bdaee1873ea.tar.gz
Clarify examples README
-rw-r--r--examples/README20
-rw-r--r--examples/demo/README15
2 files changed, 18 insertions, 17 deletions
diff --git a/examples/README b/examples/README
index d3ad328..a65715c 100644
--- a/examples/README
+++ b/examples/README
@@ -1,25 +1,11 @@
Example sets of service definition directories.
-demo:
-
- It is a manually constructed set of services, separated
-into two stores, meant to be used with the repo commands
-of s6-rc, or with the s6-frontend package, so that users
-can test the commands in a sandbox.
- demo/0 and demo/1 should be the stores, hosting the service definitions.
- Uppercase means the service is a longrun. Lowercase means the
-service is a oneshot.
- Services named E*|e* are essential.
- Services named R*|r* are recommended, i.e. they should appear as
-"active" rather than "usable" by default.
- Services named N*|n* are only "usable" by default.
- The number identifies the service.
- Foo-log means the service is a logger for Foo.
- Services that don't follow the format are bundles.
+demo: a manually constructed set of services, hosted
+in two stores, to test and familiarize yourself with the
+repo commands and s6-frontend. See demo/README.
source-router:
-
It is a real life example, used for the configuration of
a router with 4 ethernet interfaces and 2 wifi ones, behind
two ISPs (one fiber, one DSL), running a few services such
diff --git a/examples/demo/README b/examples/demo/README
new file mode 100644
index 0000000..1d9cf68
--- /dev/null
+++ b/examples/demo/README
@@ -0,0 +1,15 @@
+0 and 1 are two stores, containing a manually constructed set of
+services. They are meant to be used with the repo commands of s6-rc,
+or with the s6-frontend package, to help you get familiar with the
+commands.
+
+ An uppercase service name means the service is a longrun. A
+lowercase one means the service is a oneshot.
+ Services named E*|e* are essential.
+ Services named R*|r* are recommended, i.e. they should appear as
+"active" rather than "usable" by default.
+ Services named N*|n* are only "usable" by default.
+ Foo-log means the service is a logger for Foo.
+ "essentials" is a bundle that every non-essential service should
+depend on, in order to only start after all the essential services
+are up.