Merge branch 'summary' into 'main'

docs: add description of the target system to README

Closes #13

See merge request larswirzenius/v-i!36

1 files changed, 11 insertions, 0 deletions

diff --git a/README.md b/README.md
index 86ba2a0..8976822 100644
--- a/README.md
+++ b/README.md
@@ -15,6 +15,17 @@ service suite: it's meant to provide a base on which such can be
 installed. However, **v-i** can probably do that, but the [author][]
 thinks such setup and configuration is better done post-install.
 
+**v-i** installs a very basic system that is only really suitable as a
+target for provisioning using your configuration management system of
+choice (the author uses Ansible). The basic system allows you to log
+in as root with SSH using the key you provide to **v-i**. The
+installer removes all partitions on all drives on the system, and sets
+up LUKS and LVM2 on all the drives you specify. It sets up the time
+zone and console keyboard layout you specify. It installs the
+`locales-all` package so your locale is available. It sets up the
+system to use the `deb.debian.org` Debian CDN mirror network. Anything
+else you'll have to install and configure yourself.
+
 **v-i** installs a very basic Debian onto a PC. It's entirely
 non-interactive and unhelpful. The author wrote it so that repeated
 installations would be less of a chore than using the official Debian