Merge pull request #16 from dreemurrs-embedded/readme

Much more friendly readme
This commit is contained in:
Martijn Braam 2020-05-02 17:06:50 +02:00 committed by GitHub
commit d9c599bda9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -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)