From f3ef58ce9fee03d05d76fe86f8604fda6a011054 Mon Sep 17 00:00:00 2001 From: Danct12 Date: Fri, 24 Apr 2020 18:49:17 +0700 Subject: [PATCH] Much more friendly readme Signed-off-by: Danct12 --- README.md | 31 +++++++++++++++++++++++-------- 1 file changed, 23 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index b9235d5..6940d0b 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,24 @@ -# Jumpdrive for PinePhone +# Jumpdrive -This image is a swiss army knife solution for **PinePhone eMMC**. +The swiss army knife of Pine64 devices (currently only Pinetab and PinePhone) You can use this to flash a image **directly to eMMC**, troubleshooting a broken system, and a lot more. -## This project is built on: -- [Busybox](https://busybox.net) - which is [GPLv2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html). -- [postmarketOS](https://postmarketos.org) scripts - which is [GPLv2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html). -- [Pine64's kernel fork](https://gitlab.com/pine64-org/linux) - which is [GPLv2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html). -- [U-Boot](https://github.com/u-boot/u-boot) - which has [multiple licenses](https://github.com/u-boot/u-boot/tree/master/Licenses) +### Table of Contents +- [Installation](#installation) +- [Building](#building) +- [List of projects being used in Jumpdrive](#this-project-is-built-on) -## Building +### Installation +Download the latest image for your device [here](https://github.com/dreemurrs-embedded/Jumpdrive/releases) + +Then use dd to flash the image to an SD card. Jumpdrive is pretty small, so there is no need for a large storage SD card. + +Insert the SD card to the device, then boot it up, you should get a nice splash screen and you should see a new storage device after you plug the device to USB. + +With the device plugged in, you can now flash a distro, or fix a unbootable installation. + +### Building The dependencies are: @@ -31,3 +39,10 @@ Generate only the initramfs for the pinephone $ make -j8 all Generates an image for every supported platform in parallel ``` + +### This project is built on: +- [Busybox](https://busybox.net) - which is [GPLv2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html). +- [postmarketOS](https://postmarketos.org) scripts - which is [GPLv2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html). +- [Pine64's kernel fork](https://gitlab.com/pine64-org/linux) - which is [GPLv2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html). +- [U-Boot](https://github.com/u-boot/u-boot) - which has [multiple licenses](https://github.com/u-boot/u-boot/tree/master/Licenses) +