From a7ce0c374f6104bfc283f39b4288a228c89f9346 Mon Sep 17 00:00:00 2001
From: Renken <renken@shione.net>
Date: Sun, 24 Dec 2023 20:41:52 +0100
Subject: readme: debian configuration packages

---
 README.md | 49 ++++++++++++++++++++++++++++++++-----------------
 1 file changed, 32 insertions(+), 17 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 1b0d9de..c1b1940 100644
--- a/README.md
+++ b/README.md
@@ -1,35 +1,50 @@
 # Nichijou
 
-Experimental Guix packaging and configuration. This project is mainly for
+Experimental Debian packaging and configuration. This project is mainly for
 educational purposes. However, the aim is to produce a per-host shared
 configuration that would suit my real world usage.
 
-# Siga
+## Host machines
 
-My personal computer which runs GNU/Linux Debian testing.
+### Siga
 
-## TODO
+[Desktop PC](https://shione.net/log/archive/2023/06/1687104871/index.html)
+running GNU/Linux Debian stable.
 
-# Shione
+### Tabi
 
-My GNU/Linux Debian stable sever which is no longer operation, it will have a
-basic home configuration with only neovim on it.
+Lenovo Thinkpad x260 laptop running GNU/Linux Debian stable.
 
-## TODO
+### Shione
 
-* Perhaps a bash configuration that is produces essentials of the zsh one?
+NiPoGi CK10 with the Intel Core i7-10810U Mini PC server running GNU/Linux
+Debian stable.
 
-# [insert work computer name here]
+## HOWTO
 
-My work computer which should run GNU/Linux Debian either stable or testing. It
-doesn't exist yet.
+Because all of my machines run 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.
 
-## TODO
+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.
 
-* Neovim and zsh.
+## Project hierarchy
 
-# Configuration TODOs
+It is not yet clear to me how I'll do this. I'm thinking perhaps
+`config/$host/$package` with the exception of `config/generic/$package` for
+host-generic packages such as `neovim` for `siga` and `tabi`.
 
-# Packages TODOs
+### NOTES
 
-* mpv-webm
+```console
+$ debuild
+$ debuild -T clean
+```
-- 
cgit v1.2.3