From 59a6f5428b2336baf03f42632e55293f09e4c2a8 Mon Sep 17 00:00:00 2001 From: Nikhil Jha Date: Mar 30 2020 03:15:16 +0000 Subject: Make the README look nicer --- diff --git a/README.md b/README.md index 73d697b..f64ceb0 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ -# **🚨🚨🚨 WARNING! 🚨🚨🚨** -This is a *barely tested* collection of scripts written by someone who has never written a bash script for other people to use! It involves the *dd* command and *sudo*. This is **VERY DANGEROUS** - please do not run it unless you have read and fully understood what it will do. Better yet, read the scripts to learn how to do things yourself. In any case, I'm not responsible for anything that you do with this code. +# PinePhone Fedora Setup -# sdsetup +A collection of scripts that correctly sets up Fedora to run off your PinePhone SD card. Soon to be part of the Fedora Mobility SIG. -A collection of scripts that correctly sets up Fedora to run off your PinePhone SD card. +## **🚨🚨🚨 WARNING! 🚨🚨🚨** +This is a **barely tested** collection of scripts written by someone who has never written a bash script for other people to use! It involves the **dd** command and **sudo**. This is **VERY DANGEROUS** - please do not run it unless you have read and fully understood what it will do. Better yet, read the scripts to learn how to install the image manually. ## Dependencies @@ -16,12 +16,10 @@ A collection of scripts that correctly sets up Fedora to run off your PinePhone ## Usage -0. Use bash. `fish` and other weird shells are unsupported. -1. Edit `.env` with your own variables. -2. Ensure that all of your SD card partitions are unmounted, but visible in `lsblk`. -3. Run `bash 00-download-files.sh` then `sudo bash all.sh`, verify the information presented whenever it asks you to confirm. +1. Edit `.env` with your own variables. It is especially important to update the Rawhide filename, as that is updated on Fedora's end daily. +2. Run `bash download-files.sh` then `sudo bash all.sh`. Verify the information presented whenever it asks you to confirm. ## Tips -- Run all scripts other than 00-download-files.sh as root, and from this (README.md) directory! Do not directly run anything in the phone-scripts folder! -- If a script fails midway through, some things may still be mounted. `cleanup.sh` will attempt to unmount everything. Once again, run it as root! +- Run all scripts other than download-files.sh as root, and from this (README.md) directory! Do not directly run anything in the phone-scripts folder! Those scripts are, as the name suggests, executed on the phone. +- If a script fails midway through, some things may still be mounted. `sudo ./cleanup.sh` will attempt to unmount everything.