summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--support-a-new-distro.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/support-a-new-distro.md b/support-a-new-distro.md
new file mode 100644
index 0000000..13655d3
--- /dev/null
+++ b/support-a-new-distro.md
@@ -0,0 +1,19 @@
+# Support a new distro
+
+## Global variables
+
+- ``ROOTPATH``: root of a USB stick mountpoint
+- ``KERNELDIR``: the place to install the kernel
+- ``DATADIR``: the place to install other data files, e.g. squashfs, iso files
+- ``ISOMNT``: the mount point that the iso file is mounted to with ``mount_iso``
+
+## How to support
+
+You can refer to [Arch Linux](distro/arch/). What you need is:
+
+- ``grub.cfg``: write the menuentry for your distro
+- ``install.sh``: a script file describing how to install the LiveCD to USB
+- ``mirrorlist``: where to download the iso file
+
+In ``install.sh``, ``ISOURL`` is the relative path to a mirror that shows the URL of the Live ISO file. You can use ``SHA256``,``SHA1`` or ``MD5`` for iso file checksum. ``install_live`` is the bash function that handles the install of the Live ISO to the USB stick.
+