Update Makefile, add AUTHORS.rst, CONTRIBUTING.rst and README.rst

Signed-off-by: David P <megver83@parabola.nu>

1 files changed, 123 insertions, 0 deletions

diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..7b1b6e7
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,123 @@
+===========
+parabolaiso
+===========
+
+The parabolaiso project features scripts and configuration templates to build installation media (*.iso* images) for BIOS
+and UEFI based systems on the x86_64 and i686 architectures.
+Currently creating the images is only supported on Parabola GNU/Linux-libre.
+
+Requirements
+============
+
+The following packages need to be installed to be able to create an image with the included scripts:
+
+* arch-install-scripts
+* dosfstools
+* e2fsprogs
+* libisoburn
+* squashfs-tools
+
+For running the images in a virtualized test environment the following packages are required:
+
+* edk2-ovmf
+* qemu
+
+For linting the shell scripts the following package is required:
+
+* shellcheck
+
+Profiles
+========
+
+parabolaiso comes with the following profiles: **baseline**, **releng**, **releng-openrc**, **lxde-openrc** and **talkingparabola**.
+They can be found below `configs/baseline/ <configs/baseline/>`_, `configs/releng/ <configs/releng/>`_,
+`configs/releng-openrc/ <configs/releng-openrc/>`_, `configs/lxde-openrc/ <configs/lxde-openrc/>`_, `configs/talkingparabola/ <configs/talkingparabola/>`_
+(respectively). Profiles are defined by files to be placed into overlays (e.g. *airootfs* -> *the image's /*) and
+dynamic actions (i.e. *build.sh* scripts).
+
+Create images
+=============
+
+Usually the parabolaiso tools are installed as a package. However, it is also possible to clone this repository and create
+images without installing parabolaiso system-wide.
+
+As filesystems are created and various mount actions have to be done when creating an image, **root** is required to run
+the scripts.
+
+When parabolaiso is installed system-wide and the modification of a profile is desired, it is necessary to copy it to a
+writeable location, as */usr/share/parabolaiso* is tracked by the package manager and only writeable by root (changes will
+be lost on update).
+
+The examples below will assume an unmodified profile in a system location (unless noted otherwise).
+
+It is advised to check the help information of the **build.sh** scripts in the profiles:
+
+  .. code:: bash
+
+    /usr/share/parabolaiso/configs/releng/build.sh --help
+
+Create images with packaged parabolaiso
+---------------------------------------
+
+  .. code:: bash
+
+    /usr/share/parabolaiso/configs/releng/build.sh -w path/to/work_dir -o path/to/out_dir
+
+Create images with local clone
+------------------------------
+
+Clone this repository and make sure to run with the local `mkparabolaiso <parabolaiso/mkparabolaiso>`_  script in *PATH* (if it has
+been modified):
+
+  .. code:: bash
+
+    PATH="parabolaiso:$PATH" ./configs/releng/build.sh -w path/to/work_dir -o path/to/out_dir
+
+Testing
+=======
+
+The convenience script **run_parabolaiso** is provided to boot into the medium using qemu.
+It is advised to read its help information:
+
+  .. code:: bash
+
+    run_parabolaiso -h
+
+Run the following to boot the iso using BIOS:
+
+  .. code:: bash
+
+    run_parabolaiso -i path/to/an/parabola.iso
+
+Run the following to boot the iso using UEFI:
+
+  .. code:: bash
+
+    run_parabolaiso -i path/to/an/parabola.iso -u
+
+The script can of course also be executed from this repository:
+
+
+  .. code:: bash
+
+    ./scripts/run_parabolaiso.sh -i path/to/an/parabola.iso
+
+Installation
+============
+
+To install parabolaiso system-wide use the included **Makefile**:
+
+  .. code:: bash
+
+    make install
+
+Optionally install parabolaiso's mkinitcpio hooks:
+
+  .. code:: bash
+
+    make install-initcpio
+
+License
+=======
+
+parabolaiso is licensed under the terms of the **GPL-3.0-or-later** (see `LICENSE <LICENSE>`_).