From 554645ab96632d2c3495fe15761d865eaead9e34 Mon Sep 17 00:00:00 2001 From: Colin Sauze Date: Tue, 3 Sep 2024 17:08:07 +0100 Subject: [PATCH] reordering readme to prioritise prebuilt images --- README.md | 45 ++++++++++++++++++++++++--------------------- 1 file changed, 24 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 9e25fc4..bc0fbe2 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,28 @@ This repository contains scripts to intialise a Raspberry Pi with the Carpentrie ## You will need: * A Raspberry Pi with an internet connection * An installation of Raspberry Pi OS Lite -* 2.5GB of more free on the SD card +* 3GB of more free on the SD card -## Setting up a Raspberry Pi with an operating system: +## Using pre-built images +There are pre-built images available from the releases section of this page. These are experimental and unlikely to be fully working yet. +These are built as multipart zip files with names like release.zip and release.z01, this is due to a 2GB upload limit in our build process. Download each of these. To extract them on a Linux system run the following: + +`cat release.z01 release.zip > carpentries-offline.zip` + +`unzip carpentries-offline.zip` + +After you have downloaded and unzipped the image files, write the image file to an SD card with [Etcher](https://www.balena.io/etcher/) or your image writing program of choice. + +## Connect to Carpentries Offline +* After installing the Raspberry Pi will reboot. +* It will then switch the WiFi interface to access point mode and will be available as a network called carpentries-offline. +* Connect to the carpenpi WiFi network +* Visting http://carpentriesoffline.org or http://192.168.1.1 +* You should get links to the Carpentries Lessons and the Gitea server on the Raspberry Pi + +## Building the image yourself: + +### Setting up a Raspberry Pi with an operating system: * Download Raspbian OS Lite: https://www.raspberrypi.org/software/operating-systems/ * Write image to SD card using rpi-imager: https://www.raspberrypi.org/software/ @@ -33,29 +52,13 @@ network={ } ``` -## Run the install script +### Run the install script * Login to your Raspberry Pi with an SSH client or on a local screen/keyboard and run the command: * curl https://raw.githubusercontent.com/carpentriesoffline/carpentriesoffline-installer/main/setup.sh > setup.sh && bash ./setup.sh -## Change the password -* Run the passwd command. Leaving the default password will mean anybody in your workshop can login to your Pi and change settings on it. +### Change the password +* Run the passwd command. Leaving the default password will mean anybody in your workshop can login to your Pi and change settings on it -## Connect to Carpentries Offline -* After installing the Raspberry Pi will reboot. -* It will then switch the WiFi interface to access point mode and will be available as a network called carpentries-offline. -* Connect to the carpenpi WiFi network -* Visting http://carpentriesoffline.org or http://192.168.1.1 -* You should get links to the Carpentries Lessons and the Gitea server on the Raspberry Pi - -## Using pre-built images -There are pre-built images available from the releases section of this page. These are experimental and unlikely to be fully working yet. -These are built as multipart zip files with names like release.zip and release.z01, this is due to a 2GB upload limit in our build process. Download each of these. To extract them on a Linux system run the following: - -`cat release.z01 release.zip > carpentries-offline.zip` - -`unzip carpentries-offline.zip` - -After you have downloaded and unzipped the image files, write the image file to an SD card with [Etcher](https://www.balena.io/etcher/) or your image writing program of choice. # Development Status