Verified Commit 5754000d authored by nl6720's avatar nl6720
Browse files

Update README.rst

* Don't nest code blocks inside quote blocks.
* Replace bash with sh, as there's nothing bash-specific in the examples.
* There is no syntax highlighting for grub, use sh.
* Use sentence case for headings.
* Use monospace for paths.
parent 06c32187
...@@ -33,7 +33,7 @@ Profiles ...@@ -33,7 +33,7 @@ Profiles
Archiso comes with two profiles: **baseline** and **releng**. While both can serve as starting points for creating Archiso comes with two profiles: **baseline** and **releng**. While both can serve as starting points for creating
custom live media, **releng** is used to create the monthly installation medium. custom live media, **releng** is used to create the monthly installation medium.
They can be found below `configs/baseline/ <configs/baseline/>`_ and `configs/releng/ <configs/releng/>`_ They can be found below `configs/baseline/ <configs/baseline/>`_ and `configs/releng/ <configs/releng/>`_
(respectively). Both profiles are defined by files to be placed into overlays (e.g. *airootfs* -> *the image's /*). (respectively). Both 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 <README.profile.rst>`_ to learn more about how to create profiles.
...@@ -47,32 +47,32 @@ As filesystems are created and various mount actions have to be done when creati ...@@ -47,32 +47,32 @@ As filesystems are created and various mount actions have to be done when creati
the scripts. the scripts.
When archiso is installed system-wide and the modification of a profile is desired, it is necessary to copy it to a When archiso 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/archiso* is tracked by the package manager and only writeable by root (changes will writeable location, as ``/usr/share/archiso`` is tracked by the package manager and only writeable by root (changes will
be lost on update). be lost on update).
The examples below will assume an unmodified profile in a system location (unless noted otherwise). The examples below will assume an unmodified profile in a system location (unless noted otherwise).
It is advised to consult the help output of **mkarchiso**: It is advised to consult the help output of **mkarchiso**:
.. code:: bash .. code:: sh
mkarchiso -h mkarchiso -h
Create images with packaged archiso Create images with packaged archiso
----------------------------------- -----------------------------------
.. code:: bash .. code:: sh
mkarchiso -w path/to/work_dir -o path/to/out_dir path/to/profile mkarchiso -w path/to/work_dir -o path/to/out_dir path/to/profile
Create images with local clone Create images with local clone
------------------------------ ------------------------------
Clone this repository and run: Clone this repository and run:
.. code:: bash .. code:: sh
./archiso/mkarchiso -w path/to/work_dir -o path/to/out_dir path/to/profile ./archiso/mkarchiso -w path/to/work_dir -o path/to/out_dir path/to/profile
Testing Testing
======= =======
...@@ -80,61 +80,60 @@ Testing ...@@ -80,61 +80,60 @@ Testing
The convenience script **run_archiso** is provided to boot into the medium using qemu. The convenience script **run_archiso** is provided to boot into the medium using qemu.
It is advised to consult its help output: It is advised to consult its help output:
.. code:: bash .. code:: sh
run_archiso -h run_archiso -h
Run the following to boot the iso using BIOS: Run the following to boot the iso using BIOS:
.. code:: bash .. code:: sh
run_archiso -i path/to/an/arch.iso run_archiso -i path/to/an/arch.iso
Run the following to boot the iso using UEFI: Run the following to boot the iso using UEFI:
.. code:: bash .. code:: sh
run_archiso -u -i path/to/an/arch.iso run_archiso -u -i path/to/an/arch.iso
The script can of course also be executed from this repository: The script can of course also be executed from this repository:
.. code:: bash .. code:: sh
./scripts/run_archiso.sh -i path/to/an/arch.iso ./scripts/run_archiso.sh -i path/to/an/arch.iso
Installation Installation
============ ============
To install archiso system-wide use the included **Makefile**: To install archiso system-wide use the included ``Makefile``:
.. code:: bash .. code:: sh
make install make install
Optionally install archiso's mkinitcpio hooks: Optionally install archiso'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 name and version. This allows to 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. boot the iso image from GRUB with a version specific cow directory to mitigate overlay clashes.
.. code:: grub .. code:: sh
loopback loop archlinux.iso loopback loop archlinux.iso
load_env -f (loop)/arch/grubenv load_env -f (loop)/arch/grubenv
linux (loop)/arch/boot/x86_64/vmlinuz-linux ... \ linux (loop)/arch/boot/x86_64/vmlinuz-linux ... \
cow_directory=${NAME}/${VERSION} ... cow_directory=${NAME}/${VERSION} ...
initrd (loop)/arch/boot/x86_64/initramfs-linux-lts.img initrd (loop)/arch/boot/x86_64/initramfs-linux-lts.img
Contribute Contribute
========== ==========
Development of archiso takes place on Arch Linux' Gitlab: https://gitlab.archlinux.org/archlinux/archiso Development of archiso takes place on Arch Linux' Gitlab: https://gitlab.archlinux.org/archlinux/archiso.
Please read our distribution-wide `Code of Conduct <https://wiki.archlinux.org/index.php/Code_of_conduct>`_ before Please read our distribution-wide `Code of Conduct <https://wiki.archlinux.org/index.php/Code_of_conduct>`_ before
contributing, to understand what actions will and will not be tolerated. contributing, to understand what actions will and will not be tolerated.
...@@ -153,20 +152,20 @@ Releases ...@@ -153,20 +152,20 @@ Releases
`Releases of archiso <https://gitlab.archlinux.org/archlinux/archiso/-/tags>`_ are created by its current maintainer `Releases of archiso <https://gitlab.archlinux.org/archlinux/archiso/-/tags>`_ are created by its current maintainer
`David Runge <https://gitlab.archlinux.org/dvzrv>`_. Tags are signed using the PGP key with the ID `David Runge <https://gitlab.archlinux.org/dvzrv>`_. Tags are signed using the PGP key with the ID
`C7E7849466FE2358343588377258734B41C31549`. ``C7E7849466FE2358343588377258734B41C31549``.
To verify a tag, first import the relevant PGP key: To verify a tag, first import the relevant PGP key:
.. code:: bash .. code:: sh
gpg --auto-key-locate wkd --search-keys dvzrv@archlinux.org gpg --auto-key-locate wkd --search-keys dvzrv@archlinux.org
Afterwards a tag can be verified from a clone of this repository: 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 License
======= =======
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment