From 6108d67a274ca58520af4f8b00317ef0fc2ba1f4 Mon Sep 17 00:00:00 2001 From: anntnzrb Date: Mon, 21 Jun 2021 10:14:02 -0500 Subject: [PATCH 1/5] Avoid wrapping links --- README.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 724fe0a..e0946ce 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,23 @@ # System Crafters Guix Installer -This repository runs automated CI builds to produce a [GNU -Guix](https://guix.gnu.org) installation image using the **full Linux kernel** -from the [Nonguix channel](https://gitlab.com/nonguix/nonguix). If you are -using a modern laptop or hardware that is incompatible with the Linux Libre -kernel, this installer image is for you! +This repository runs automated CI builds to produce a +[GNU Guix](https://guix.gnu.org) installation image using the +**full Linux kernel** from the +[Nonguix channel](https://gitlab.com/nonguix/nonguix). If you are using a +modern laptop or hardware that is incompatible with the **Linux Libre kernel**, +this installer image is for you! -You can take a look at the [image configuration](installer.scm) and the [build -workflow](.github/workflows/build.yaml) to be sure that we aren't adding +You can take a look at the [image configuration](installer.scm) and the +[build workflow](.github/workflows/build.yaml) to be sure that we aren't adding anything malicious to these builds! -A new ISO is produced at least once a week, sometimes more often if we're making -improvements to the configuration. +A new ISO is produced at least once a week, sometimes more often if we're +making improvements to the configuration. Special thanks to [@anntnzrb](https://github.com/anntnzrb) for providing the starting point for the CI configuration! ## License -The code in this repository is licensed under the [GNU General Public License v3](LICENSE.txt). +The code in this repository is licensed under the +[GNU General Public License v3](LICENSE.txt). From 25e7d5b753ef754d8dd81bbe838072856406cd9d Mon Sep 17 00:00:00 2001 From: anntnzrb Date: Mon, 21 Jun 2021 10:35:51 -0500 Subject: [PATCH 2/5] Added TOC & attributions section --- README.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index e0946ce..b4b310e 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,24 @@ # System Crafters Guix Installer -This repository runs automated CI builds to produce a +This repository runs _automated CI builds_ to produce a [GNU Guix](https://guix.gnu.org) installation image using the **full Linux kernel** from the [Nonguix channel](https://gitlab.com/nonguix/nonguix). If you are using a modern laptop or hardware that is incompatible with the **Linux Libre kernel**, this installer image is for you! -You can take a look at the [image configuration](installer.scm) and the -[build workflow](.github/workflows/build.yaml) to be sure that we aren't adding -anything malicious to these builds! +## Table of Contents :toc:noexport: +- [System Crafters Guix Installer](#system-crafters-guix-installer) + - [Attributions](#attributions) + - [License](#license) -A new ISO is produced at least once a week, sometimes more often if we're -making improvements to the configuration. +## Attributions -Special thanks to [@anntnzrb](https://github.com/anntnzrb) for providing the -starting point for the CI configuration! +- [@anntnzrb](https://github.com/anntnzrb) for providing the starting point for + the _CI_ configuration. +- [@daviwil](https://github.com/daviwil) for releasing the finished _CI_ + configuration and getting everything up and running. +- The [System Crafters](https://systemcrafters.cc)' community. ## License From bf5f71039731fdd1e82a90d44419649aeeff6e8e Mon Sep 17 00:00:00 2001 From: anntnzrb Date: Mon, 21 Jun 2021 10:59:36 -0500 Subject: [PATCH 3/5] Added instructions section --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/README.md b/README.md index b4b310e..bf97868 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,46 @@ this installer image is for you! ## Table of Contents :toc:noexport: - [System Crafters Guix Installer](#system-crafters-guix-installer) + - [Instructions](#instructions) - [Attributions](#attributions) - [License](#license) +## Instructions + +1. Download a recently built `.iso` from this repo's + [release page](https://github.com/SystemCrafters/guix-installer/releases) +2. Flash the `.iso` file into a USB stick with at least `3Gb`. + +### Flashing the ISO + +As stated in _step #2_ at [Instructions](#instructions), you will need to flash +the `.iso` file into a USB stick. + +**[*]nix**: + +You should only need the `dd` utility (_coreutils_): + +- `dd status=progress if=guix-installerYYYYMMDDHHMM.iso of=/dev/foo` + - where `guix-installerYYYYMMDDHHMM.iso` is the name of the downloaded `.iso` + image and `foo` the name of the targeted device to flash the image. + +For the sake of providing an example, here's the full command: + +```sh +`dd status=progress if=guix-installer-202106150234.iso of=/dev/sdb` +``` + +**NOTE #1**: You can list your devices with `lsblk`. + +**NOTE #2**: If `dd` won't work for some reason, refer to the **Windows**. + +**Windows**: + +- [balenaEtcher](https://www.balena.io/etcher) is a great **cross-platform** + _FOSS_ utility for flashing _GNU/Linux_ images. +- If the above doesn't work, you might give [Rufus](https://rufus.ie/en_US/) a + look. + ## Attributions - [@anntnzrb](https://github.com/anntnzrb) for providing the starting point for From c9774d9271fe04f0d7ebbb310ed9955e03b762e6 Mon Sep 17 00:00:00 2001 From: anntnzrb Date: Mon, 21 Jun 2021 11:02:47 -0500 Subject: [PATCH 4/5] Re-added security concerns notice | minor fix --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bf97868..bcf3b07 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,14 @@ This repository runs _automated CI builds_ to produce a modern laptop or hardware that is incompatible with the **Linux Libre kernel**, this installer image is for you! -## Table of Contents :toc:noexport: +You may take a look at the [image configuration](./installer.scm) and the +[build workflow](./.github/workflows/build.yaml) to be sure that we aren't adding +anything malicious to these builds! + +**A new ISO is produced at least once a week, sometimes more often if we're +making improvements to the configuration.** + +## Table of Contents - [System Crafters Guix Installer](#system-crafters-guix-installer) - [Instructions](#instructions) - [Attributions](#attributions) @@ -60,4 +67,4 @@ For the sake of providing an example, here's the full command: ## License The code in this repository is licensed under the -[GNU General Public License v3](LICENSE.txt). +[GNU General Public License v3](./LICENSE.txt). From e64463773d80e31beca1b31ba956b7a757126822 Mon Sep 17 00:00:00 2001 From: anntnzrb Date: Mon, 21 Jun 2021 11:07:54 -0500 Subject: [PATCH 5/5] Minor visual improvements --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index bcf3b07..41792ad 100644 --- a/README.md +++ b/README.md @@ -11,8 +11,8 @@ You may take a look at the [image configuration](./installer.scm) and the [build workflow](./.github/workflows/build.yaml) to be sure that we aren't adding anything malicious to these builds! -**A new ISO is produced at least once a week, sometimes more often if we're -making improvements to the configuration.** +**A new `.iso` image is produced at least once a week, sometimes more often if +we're making improvements to the configuration.** ## Table of Contents - [System Crafters Guix Installer](#system-crafters-guix-installer) @@ -42,12 +42,12 @@ You should only need the `dd` utility (_coreutils_): For the sake of providing an example, here's the full command: ```sh -`dd status=progress if=guix-installer-202106150234.iso of=/dev/sdb` +dd status=progress if=guix-installer-202106150234.iso of=/dev/sdb ``` -**NOTE #1**: You can list your devices with `lsblk`. +> NOTE #1: You can list your devices with `lsblk`. -**NOTE #2**: If `dd` won't work for some reason, refer to the **Windows**. +> NOTE #2: If `dd` won't work, refer to the **Windows** section. **Windows**: