sync with archisov53

Imported:
42cdf86 (HEAD -> master, origin/master, origin/HEAD) Set more generic output for signatures
cc735db Force PGP signature file extension
73e3ccd Add ephemeral signing key to CI setup
e2cce07 (tag: v53) Add changelog for v53
9dbb600 Add packages for unlocking LUKS2 volumes with systemd
81da518 Add required packages to interact with smartcards
6287f72 Remove docs/README.knownissues. Replaced by issue #83.
76c8030 Remove docs/README.build. Superseded by README.rst
a855dd4 Move README.profile.rst to docs/
6294d1d Update README.profile.rst
5754000 Update README.rst
06c3218 configs/releng/syslinux/: increase serial baud rate to 115200
0406f9c mkarchiso: create reproducible gzip archives
a771297 mkarchiso: make sure to remove potentially preexisting files from $airootfs_dir before creating them with output redirection
98c7b67 mkarchiso: append IMAGE_ID and IMAGE_VERSION to /etc/os-release
0ed1c61 Add package count, El Torito EFI image size and initramfs image sizes to GitLab metrics
8bf95d3 Ignore SC3060 in initcpio hook
bde3971 Fix shellcheck complains in CI scripts
1a97109 mkarchiso: also add iso name in grub environment block
09b6127 mkarchiso: use -isohybrid-gpt-basdat instead of -appended_part_as_gpt for ISOs that will support BIOS booting

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

1 files changed, 37 insertions, 38 deletions

diff --git a/README.rst b/README.rst
index 5ff73c9..25f16a0 100644
--- a/README.rst
+++ b/README.rst
@@ -34,9 +34,9 @@ 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 /*).
+(respectively). Profiles are defined by files to be placed into overlays (e.g. airootfs → the image's ``/``).
 
-Read `README.profile.rst <README.profile.rst>`_ to learn more about how to create profiles.
+Read `README.profile.rst <docs/README.profile.rst>`_ to learn more about how to create profiles.
 
 Create images
 =============
@@ -48,32 +48,32 @@ As filesystems are created and various mount actions have to be done when creati
 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
+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 consult the help output of **mkparabolaiso**:
 
-  .. code:: bash
+.. code:: sh
 
-    mkparabolaiso -h
+   mkparabolaiso -h
 
 Create images with packaged parabolaiso
 ---------------------------------------
 
-  .. code:: bash
+.. code:: sh
 
-    mkparabolaiso -w path/to/work_dir -o path/to/out_dir path/to/profile
+  mkparabolaiso -w path/to/work_dir -o path/to/out_dir path/to/profile
 
 Create images with local clone
 ------------------------------
 
 Clone this repository and run:
 
-  .. code:: bash
+.. code:: sh
 
-    ./parabolaiso/mkparabolaiso -w path/to/work_dir -o path/to/out_dir path/to/profile
+  ./parabolaiso/mkparabolaiso -w path/to/work_dir -o path/to/out_dir path/to/profile
 
 Testing
 =======
@@ -81,61 +81,60 @@ 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
+.. code:: sh
 
-    run_parabolaiso -h
+  run_parabolaiso -h
 
 Run the following to boot the iso using BIOS:
 
-  .. code:: bash
+.. code:: sh
 
-    run_parabolaiso -i path/to/a/parabola.iso
+  run_parabolaiso -i path/to/a/parabola.iso
 
 Run the following to boot the iso using UEFI:
 
-  .. code:: bash
+.. code:: sh
 
-    run_parabolaiso -u -i path/to/a/parabola.iso
+  run_parabolaiso -u -i path/to/a/parabola.iso
 
 The script can of course also be executed from this repository:
 
 
-  .. code:: bash
+.. code:: sh
 
-    ./scripts/run_parabolaiso.sh -i path/to/a/parabola.iso
+  ./scripts/run_parabolaiso.sh -i path/to/a/parabola.iso
 
 Installation
 ============
 
-To install parabolaiso system-wide use the included **Makefile**:
+To install parabolaiso system-wide use the included ``Makefile``:
 
-  .. code:: bash
+.. code:: sh
 
-    make install
+  make install
 
 Optionally install parabolaiso's mkinitcpio hooks:
 
-  .. code:: bash
+.. code:: sh
 
-    make install-initcpio
+  make install-initcpio
 
-Optional Features
-=================
+Optional features
 
-The iso image contains a grub environment block holding the iso version. This allows to boot the iso image from grub
-with a version specific cow directory to mitigate overlay clashes.
+The iso image contains a GRUB environment block holding the iso name and version. This allows to
+boot the iso image from GRUB with a version specific cow directory to mitigate overlay clashes.
 
-  .. code:: grub
-      loopback loop parabola.iso
-      load_env -f (loop)/parabola/grubenv
-      linux (loop)/parabola/boot/x86_64/vmlinuz-linux-libre ... \
-          cow_directory=parabola/${VERSION} ...
-      initrd (loop)/parabola/boot/x86_64/initramfs-linux-libre-lts.img
+.. code:: sh
+    loopback loop parabola.iso
+    load_env -f (loop)/parabola/grubenv
+    linux (loop)/parabola/boot/x86_64/vmlinuz-linux-libre ... \
+        cow_directory=parabola/${VERSION} ...
+    initrd (loop)/parabola/boot/x86_64/initramfs-linux-libre-lts.img
 
 Contribute
 ==========
 
-Development of parabolaiso takes place on Parabola GNU/Linux-libre' Git: https://git.parabola.nu/parabolaiso.git
+Development of parabolaiso takes place on Parabola GNU/Linux-libre' Git: https://git.parabola.nu/parabolaiso.git.
 
 Read our `contributing guide <CONTRIBUTING.rst>`_ to learn more about how to provide fixes or improvements for the code
 base.
@@ -151,20 +150,20 @@ Releases
 
 `Releases of parabolaiso <https://gitlab.com/Megver83/parabolaiso/-/tags>`_ are created by its current maintainer
 `David P <https://gitlab.com/Megver83>`_. Tags are signed using the PGP key with the ID
-`6DB9C4B4F0D8C0DC432CF6E4227CA7C556B2BA78`.
+``6DB9C4B4F0D8C0DC432CF6E4227CA7C556B2BA78``.
 
 To verify a tag, first import the relevant PGP key:
 
-  .. code:: bash
+.. code:: sh
 
-    gpg --auto-key-locate wkd --search-keys megver83@parabola.nu
+  gpg --auto-key-locate wkd --search-keys megver83@parabola.nu
 
 
 Afterwards a tag can be verified from a clone of this repository:
 
-  .. code:: bash
+.. code:: sh
 
-    git verify-tag <tag>
+  git verify-tag <tag>
 
 License
 =======