Remove old stuff, rewrite docs

1 files changed, 34 insertions, 31 deletions

diff --git a/README.rst b/README.rst
index 665a222..783602a 100644
--- a/README.rst
+++ b/README.rst
@@ -8,7 +8,7 @@
 :Status:
   Production
 :Copyright:
-  © 2018 Adélie Linux Team.  NCSA open source licence.
+  © 2018-2023 Adélie Linux Team.  NCSA open source licence.
 
 
 
@@ -21,16 +21,13 @@ Release Engineering team to create the official Adélie Linux ISO images.
 License
 ```````
 The tools contained in this repository are licensed under the NCSA open source
-license.  The bzImage files are created from the ``system/easy-kernel``
-package (the ``/boot/vmlinuz`` file created for each architecture is copied
-unchanged to ``bzImage-${ARCH}``), and as such are licensed under the kernel's
-GPL2 license.
+license.
 
 Changes
 ```````
 Any changes to this repository must be reviewed before being pushed to the
-master branch.  There are no exceptions to this rule.  For security-sensitive
-updates, contact the Security Team at sec-bugs@adelielinux.org.
+current branch.  There are no exceptions to this rule.  For security-sensitive
+updates, contact the Security Team.
 
 
 
@@ -41,39 +38,45 @@ Usage
 This section contains usage information for the software in this repository.
 
 
-``adelie-build-cd``
-```````````````````
+Using ``hscript-image`` to generate an image
+````````````````````````````````````````````
 
-This script is where the magic happens.  ``adelie-build-cd`` will create the ISO for
-the architecture specified (defaulting to the currently running system
-architecture if not specified).
+The ``configs/`` directory contains the HorizonScript files that describe the
+media you can create.  All configurations eventually inherit from the
+``base/base.installfile`` HorizonScript.
 
-``adelie-build-cd`` requires the following utilities to be installed on your computer:
+Each architecture supported for image creation has an entry in ``arch`` used
+for all media created for that architecture.
+
+The main targets used are typically:
+
+* ``live/$ARCH-kde.installfile``: Live KDE media
+* ``live/$ARCH-lxqt.installfile``: Live LXQt media
+* ``live/$ARCH-mate.installfile``: Live MATE media
+* ``horizon/$ARCH-horizon.installfile``: Installation media
+* ``horizon/$ARCH-horizon-fw.installfile``: Installation media
+  (with non-libre firmware)
+
+``hscript-image`` requires the following utilities to be installed:
 
 * apk-tools
-* cpio
 * squashfs-tools
-* A variant of ``mkisofs`` - releng uses the cdrkit package.
+* xorriso
 
-``adelie-build-cd`` is run on the Z shell on official releng machines, but should be
-functional in any POSIX compliant shell; it relies on no non-POSIX shell
-constructs.
+Typically, ``hscript-image`` is run in the following way to generate,
+for example, KDE media::
 
-The ``cdinit-${ARCH}`` file must exist in the directory that you run
-``adelie-build-cd``; it does not need to be in the same directory as the ``adelie-build-cd``
-script itself.
+    hscript-image -t iso -o adelie-$RELEASE-$ARCH-kde.iso configs/live/$ARCH-kde.installfile
 
 
-``cdinit``
-``````````
+How CDs work
+````````````
 
-This functions as early init for the CD, probing for the SquashFS root and
-mounting it appropriately.  Pre-compiled binaries statically linked to the
-current release's version of musl, util-linux, and eudev are provided for each
-Tier I and Tier II architecture of the current release.
+See the comprehensive documentation on Horizon's ISO target in that repository.
+As a cheat-sheet:
 
-You may build your own ``cdinit``, for verification purposes or for another
-architecture, and place it in the same directory as you invoke ``adelie-build-cd``.
+* ``-b issue-path=/path/to/issue/file`` - override ``/etc/issue`` on CD
+* ``-b iso-params=foo`` - append ``foo`` to ``xorriso`` parameter
 
 
 
@@ -83,7 +86,7 @@ Reporting Issues
 If you have issues installing with the official media, you should report your
 issue to `the BTS`_.
 
-If you have issues running ``adelie-build-cd`` or compiling ``cdinit``, you may file
-an issue in the GitLab repository.
+If you have issues with generating your own media, or want to discuss other
+media types, please contact the development team.
 
 .. _the BTS: http://bts.adelielinux.org/