Major rewrite: Use reclass.

1 files changed, 49 insertions, 0 deletions

diff --git a/profiles/README b/profiles/README
new file mode 100644
index 0000000..4126984
--- /dev/null
+++ b/profiles/README
@@ -0,0 +1,49 @@
+Class and node definitions
+==========================
+
+Classes and nodes are YAML files parsed by reclass.
+
+
+Classes
+-------
+
+Lowercase classes are reusable, (relatively) objective core classes.
+Never include documentation, and avoid pkg-auto or pkg-avoid items.
+
+Capital classes (first letter uppercase) and their subclasses are
+subjective high-level bundles.  Always include documentation.
+
+
+Nodes
+-----
+
+Nodes should only use capital classes, to have all actions documented.
+
+
+Parameters
+----------
+
+doc: Documentation
+doc-headline: Headline for a group of classes
+doc-pkg: Description of purpose of pkg lists in this class
+doc-tweak: Description of purpose of tweak in this class
+
+pkg: Packages to install
+pkg-auto: Packages to mark auto-installed if installed
+pkg-avoid: Packages to remove
+
+tweak: Tweaks to apply after package actions
+
+
+Tweaks
+------
+
+Tweaks are code snippets executed by a POSIX shell.
+
+Avoid ${...} (reclass use it for parameter interpolation), e.g. by
+adding dummy quotes like this: "dpkg-query -Wf='$''{Depends}\n' foo".
+
+Write tweaks for use with debian-installer, using either of below which
+will be stripped when generating script target:
+  * "chroot /target "
+  * "/target/"