summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlberto Contreras <alberto.contreras@canonical.com>2023-02-08 18:29:30 +0100
committerGitHub <noreply@github.com>2023-02-08 10:29:30 -0700
commitaba65bf6d0aca3cd09b8265b1bbbc9c8ed19bd86 (patch)
treeba5537f0093e440961621fd0a23ca9ce4da95adf
parente6e83d690aace11cc7d63a35ad316ef35441ab4b (diff)
downloadcloud-init-git-aba65bf6d0aca3cd09b8265b1bbbc9c8ed19bd86.tar.gz
readme: add reference to packages dir (#2001)
-rw-r--r--README.md4
-rw-r--r--packages/README.md13
2 files changed, 16 insertions, 1 deletions
diff --git a/README.md b/README.md
index 87864679..10e2756f 100644
--- a/README.md
+++ b/README.md
@@ -54,3 +54,7 @@ features or to verify bug fixes.
For Ubuntu, see the [Daily PPAs](https://code.launchpad.net/~cloud-init-dev/+archive/ubuntu/daily)
For CentOS, see the [COPR build repos](https://copr.fedorainfracloud.org/coprs/g/cloud-init/cloud-init-dev/)
+
+## Build / packaging
+
+To see reference build/packaging implementations, refer to [packages](packages).
diff --git a/packages/README.md b/packages/README.md
index 960ca81c..ee75fa5a 100644
--- a/packages/README.md
+++ b/packages/README.md
@@ -2,7 +2,18 @@
Package builders under this folder are development only templates. Do not rely on them.
-Downstream packaging resources:
+## Build/Install
+
+Cloud-init's build/install procedure is not OS/Distro independent as cloud-init
+is tightly couple to OS implementation details, as for example,
+the init units' definitions, see [systemd/](systemd/) and [sysvinit/](sysvinit/).
+
+For users interested in trying out cloud-init, a pre-built image is the easiest option.
+
+For users interested in packaging cloud-init, see the reference implementations under this folder
+and official packages in the following section.
+
+## Downstream packaging resources
* [arch](https://archlinux.org/packages/community/any/cloud-init/)
* [alpine](https://pkgs.alpinelinux.org/packages?name=cloud-init)