readme: init

1 files changed, 33 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9870957
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# Shione.net
+
+Experimental Debian packaging and configuration. This project is mainly for
+educational purposes. However, the aim is to package shione-specific
+configuration in a way that would allow deployment to be reproducible.
+
+## Package-specific configuration
+
+Because shione runs GNU/Linux Debian, I wish to transform per-package config
+into `.deb` packages themselves. This project is basically an application of
+[`config-package-dev`](https://debathena.mit.edu/config-package-dev/). This
+will allow me to integrate the modifications I introduce to the said packages
+within the Debian packaging system which comes with many benefits.
+
+1. Quickly rebuild a host machine from scratch if needed.
+2. Know the configuration state of each machine using the package manager.
+3. Automatically update configuration by updating the system itself.
+4. Integrate complex post-installation configuration, possibly such as
+   introducing cron jobs (is it possible?) as part of the configuration
+   package.
+
+## Project hierarchy
+
+It is not yet clear to me how I'll do this. I'm thinking perhaps about having a
+single source package that produces multiple "binary" packages. Each one would
+be a package-specific configuration. Standalone packages not specific to shione
+will probably reside in their own git repository under the Debian section.
+
+## References
+
+* https://www.eyrie.org/~eagle/notes/debian/git.html
+* https://people.debian.org/~debalance/packaging-with-git.html
+* http://honk.sigxcpu.org/projects/git-buildpackage/manual-html/gbp.import.upstream-git.html