diff options
| author | Max Rees <maxcrees@me.com> | 2018-01-14 09:00:10 +0000 |
|---|---|---|
| committer | Max Rees <maxcrees@me.com> | 2018-03-10 06:15:04 +0000 |
| commit | 393b3953a7a1f30868b0c5c1bf55403b25723581 (patch) | |
| tree | 6e8e30effaec111f6e719ae9ee9ba6258eac0e9e /README.rst | |
| parent | c3cdea15d949ed9e3612807947164fcad72e70ae (diff) | |
| download | image-393b3953a7a1f30868b0c5c1bf55403b25723581.tar.gz image-393b3953a7a1f30868b0c5c1bf55403b25723581.tar.bz2 image-393b3953a7a1f30868b0c5c1bf55403b25723581.tar.xz image-393b3953a7a1f30868b0c5c1bf55403b25723581.zip | |
Update README.rst
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 27 |
1 files changed, 13 insertions, 14 deletions
@@ -8,7 +8,7 @@ :Status: Production :Copyright: - © 2016 Adélie Linux Team. NCSA open source licence. + © 2018 Adélie Linux Team. NCSA open source licence. @@ -21,7 +21,7 @@ Release Engineering team to create the official Adélie Linux ISO images. License ``````` The tools contained in this repository are licensed under the NCSA open source -license. The bzImage files are created from the ``sys-kernel/easy-kernel`` +license. The bzImage files are created from the ``system/easy-kernel`` package (the ``/boot/vmlinuz`` file created for each architecture is copied unchanged to ``bzImage-${ARCH}``), and as such are licensed under the kernel's GPL2 license. @@ -41,27 +41,26 @@ Usage This section contains usage information for the software in this repository. -``build-cd`` -```````````` +``adelie-build-cd`` +``````````````````` -This script is where the magic happens. ``build-cd`` will create the ISO for +This script is where the magic happens. ``adelie-build-cd`` will create the ISO for the architecture specified (defaulting to the currently running system architecture if not specified). -``build-cd`` requires the following utilities to be installed on your computer: +``adelie-build-cd`` requires the following utilities to be installed on your computer: * apk-tools * cpio * squashfs-tools -* A variant of ``mkisofs`` - releng uses the cdrtools package, but you may be - able to use cdrkit. +* A variant of ``mkisofs`` - releng uses the cdrkit package. -``build-cd`` is run on the Z shell on official releng machines, but should be +``adelie-build-cd`` is run on the Z shell on official releng machines, but should be functional in any POSIX compliant shell; it relies on no non-POSIX shell constructs. The ``cdinit-${ARCH}`` file must exist in the directory that you run -``build-cd``; it does not need to be in the same directory as the ``build-cd`` +``adelie-build-cd``; it does not need to be in the same directory as the ``adelie-build-cd`` script itself. @@ -73,8 +72,8 @@ mounting it appropriately. Pre-compiled binaries statically linked to the current release's version of musl, util-linux, and eudev are provided for each Tier I and Tier II architecture of the current release. -You may build your own ``cdinit``, for veriication purposes or for another -architecture, and place it in the same directory as you invoke ``build-cd``. +You may build your own ``cdinit``, for verification purposes or for another +architecture, and place it in the same directory as you invoke ``adelie-build-cd``. @@ -84,7 +83,7 @@ Reporting Issues If you have issues installing with the official media, you should report your issue to `the BTS`_. -If you have issues running ``build-cd`` or compiling ``cdinit``, you may file +If you have issues running ``adelie-build-cd`` or compiling ``cdinit``, you may file an issue in the GitLab repository. -`the BTS`_: http://bts.adelielinux.org/ +.. _the BTS: http://bts.adelielinux.org/ |