From 9f6bc132ead44610e6f77dc249e39854089e8349 Mon Sep 17 00:00:00 2001 From: David Runge Date: Sat, 31 Jul 2021 13:52:19 +0200 Subject: CONTRIBUTING.rst: Adapt to new project name CONTRIBUTING.rst: Adapt the text to the new project name. Remove testing section, as there is currently no integration for tests. --- CONTRIBUTING.rst | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index bffc49d..4dc8a77 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -2,13 +2,13 @@ Contributing ============ -These are the contribution guidelines for archiso. +These are the contribution guidelines for mkinitcpio-archiso. All contributions fall under the terms of the GPL-3.0-or-later (see `LICENSE `_). Editorconfig ============ -A top-level editorconfig file is provided. Please configure your text editor to use it. +A top-level `editorconfig `_ file is provided. Please configure your text editor to use it. Linting ======= @@ -17,10 +17,4 @@ All ash and bash scripts are linted using shellcheck: .. code:: bash - make lint - -Testing -======= - -Contributors are expected to test their contributions by building the releng profile and running the resulting image -using `run_archiso `_. + make check -- cgit v1.2.3-54-g00ecf From 8ba2c34085967509dc120d2c9a2e12dabca541a0 Mon Sep 17 00:00:00 2001 From: David Runge Date: Sat, 31 Jul 2021 13:53:25 +0200 Subject: editorconfig: Remove project specific data .editorconfig: Remove project specific comment and the SPDX license identifier, as the configuration is not eligible for copyright. --- .editorconfig | 5 ----- 1 file changed, 5 deletions(-) diff --git a/.editorconfig b/.editorconfig index 74ed4eb..fd155ac 100644 --- a/.editorconfig +++ b/.editorconfig @@ -1,8 +1,3 @@ -# EditorConfig for archiso -# https://editorconfig.org/ -# -# SPDX-License-Identifier: GPL-3.0-or-later - # Top-most EditorConfig file root = true -- cgit v1.2.3-54-g00ecf From 22b4dca00e6f99364f3e191f67df933c08c30c30 Mon Sep 17 00:00:00 2001 From: David Runge Date: Sat, 31 Jul 2021 13:54:26 +0200 Subject: AUTHORS.rst: Truncate list of authors AUTHORS.rst: Rename the authors list and truncate it to match the current list of contributors. --- AUTHORS.rst | 19 ++++--------------- 1 file changed, 4 insertions(+), 15 deletions(-) diff --git a/AUTHORS.rst b/AUTHORS.rst index 3a03c0e..8546de1 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -1,36 +1,25 @@ -=============== -Archiso Authors -=============== +========================== +Mkinitcpio-archiso Authors +========================== * Aaron Griffin * Adam Purkrt * Alexander Epaneshnikov -* Chandan Singh -* Charles Vejnar * Christian Hesse -* Christopher Brannon * Dan McGee * David Runge * David Thurstenson -* Dieter Plaetinck -* Eli Schwartz * Florian Pritz * Francois Dupoux * Gerardo Exequiel Pozzi * Gerhard Brauer -* James Sitegen -* Justin Kromlinger -* Keshav Amburay * Loui Chang * Lukas Fleischer -* Martin Damian Fernandez * Michael Vorburger * Pierre Schmitz -* Sean Enck * Simo Leone -* Steffen Bönigk +* Simon Wilper * Sven-Hendrik Haase * Thomas Bächler -* Yu Li-Yu * nl6720 * Øyvind Heggstad -- cgit v1.2.3-54-g00ecf From ca8af5d99cf7134bfa69850b61ed742c85c8f106 Mon Sep 17 00:00:00 2001 From: David Runge Date: Sat, 31 Jul 2021 13:58:59 +0200 Subject: README.rst: Add initial README README.rst: Add initial README document with information on purpose, requirements, installation instructions, documentation, releases, contributing guidelines and license. --- README.rst | 95 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 95 insertions(+) create mode 100644 README.rst diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..87709d3 --- /dev/null +++ b/README.rst @@ -0,0 +1,95 @@ +================== +mkinitcpio-archiso +================== + +The mkinitcpio-archiso project provides `initcpio `_ integration for +`archiso `_. +The scripts offer functionality for an environment, that is running in `early user space +`_ by modifying an `initrd +`_. + +Requirements +============ + +The following packages need to be installed to be able to use mkinitcpio-archiso on a target host: + +* bash +* ca-certificates-utils (for PXE over HTTP) +* coreutils +* curl (for PXE over HTTP) +* device-mapper +* gnupg +* mkinitcpio +* mkinitcpio-nfs-utils (for PXE over NFS) +* nbd (for PXE over NBD) +* pv (optional: for displaying status when copying the image to RAM) +* util-linux + +The following packages need to be installed to be able to check the code of mkinitcpio-archiso (when running ``make +check``): + +* shellcheck +* shfmt + +Installation +============ + +To install this project, the make target ``install`` can be used. It honors both ``DESTDIR`` and ``PREFIX`` (defaults to +``/usr/local``). + +.. code:: sh + + make install DESTDIR=/some/directory PREFIX=/usr + +Documentation +============= + +Documentation on various aspects of mkinitcpio-archiso can be found in the `docs directory `_. + +Contribute +========== + +Development of mkinitcpio-archiso takes place on Arch Linux' Gitlab: +https://gitlab.archlinux.org/archlinux/mkinitcpio-archiso. + +Please read our distribution-wide `Code of Conduct `_ before +contributing, to understand what actions will and will not be tolerated. + +Read our `contributing guide `_ to learn more about how to provide fixes or improvements for the code +base. + +Discussion around mkinitcpio-archiso takes place on the `arch-releng mailing list +`_ and in `#archlinux-releng +`_ on `Libera Chat `_. + +All past and present authors of mkinitcpio-archiso are listed in `AUTHORS `_. + +Releases +======== + +`Releases of mkinitcpio-archiso `_ are created by its +current maintainer `David Runge `_. Tags are signed using the PGP key with the ID +``C7E7849466FE2358343588377258734B41C31549``. + + .. note:: + + Releases before v58 have been done as part of `archiso `_. After + ``archiso`` v57 mkinitcpio-archiso became its own project. + +To verify a tag, first import the relevant PGP key: + +.. code:: sh + + gpg --auto-key-locate wkd --search-keys dvzrv@archlinux.org + + +Afterwards a tag can be verified from a clone of this repository: + +.. code:: sh + + git verify-tag + +License +======= + +Mkinitcpio-archiso is licensed under the terms of the **GPL-3.0-or-later** (see `LICENSE `_). -- cgit v1.2.3-54-g00ecf