X-Git-Url: https://iankelling.org/git/?p=automated-distro-installer;a=blobdiff_plain;f=README;h=f7e6ef1a3727ff56c13b7e101d398282d1741159;hp=3993580079c321568409b7c6e8b6518451301dde;hb=1a5548031efc4a1fa88ca94237eac3033cf97ef1;hpb=da12892acf1eda37539938f2dd726f815b377e7a

diff --git a/README b/README
index 3993580..f7e6ef1 100644
--- a/README
+++ b/README
@@ -1,11 +1,27 @@
-Scripts for initial setup of OSes on my home network.
+Scripts for provisioning OSes on my home network.
 
-My network is a wndr3700v2 router with openwrt on it and a few pcs
-with atm: arch, debian jessie and debian stretch on them.
+Features people may find useful: installs encrypted arch, debian stable,
+& debian testing all on the same btrfs filesystem, smartly utilizing
+multiple disks, with scripts to automatically decrypt on reboots.  Disks
+are grouped as ssd or hdd and raided in raid 1 or raid 0 per
+configuration. The os raid is partitioned into boot, swap, and root,
+(only boot is unencrypted) and there are scripts to resize those
+partitions post-install if needed.
 
+It also fully automates configuration of an openwrt router after manual
+initial installation.
 
-Scripts meant to be called interactively:
+My network is a wndr3700v2 router with openwrt on it and a few pcs/laptops.
 
+Since fai requires a debian server as the fai server, there are also
+scripts to automate a debian install using pxe and preseeding, which can
+be done from any distro.
+
+Some of the scripts have dependencies for some simple obvious utility
+scripts from https://iankelling.org/git, and of course there are some
+hostnames that are specific to my network.
+
+Main scripts meant to be called interactively:
 
 arch-init-remote # install arch (after it's been booted into it's setup env)
 chboot # Set grub to boot into a different distro (installed earlier)
@@ -16,3 +32,9 @@ faiserver-uninstall
 fresize # resize swap or boot partitions in a host
 pxe-server # temporarily enable (usually) fai or arch boot server
 wrt-setup-remote  # setup my router
+
+License stuff:
+The license for the project is GPLv2 or later, mostly because fai is
+and I periodically rebase off their example setup for debian. Also,
+there is a modified encrypt.upstream, which is from the cryptsetup
+package in arch, which is under the same license.