diff --git a/README.md b/README.md index 77faaee5..bd791090 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,5 @@ # pmbootstrap -Sophisticated chroot/build/flash tool to develop and install [postmarketOS](https://ollieparanoid.github.io/post/postmarketOS). - +Sophisticated chroot/build/flash tool to develop and install postmarketOS. [Static code analysis](https://github.com/postmarketOS/pmbootstrap/blob/master/test/static_code_analysis.sh) status: [![travis badge](https://api.travis-ci.org/postmarketOS/pmbootstrap.png?branch=master)](https://travis-ci.org/postmarketOS/pmbootstrap) @@ -9,12 +8,15 @@ Sophisticated chroot/build/flash tool to develop and install [postmarketOS](http * Python 3 * OpenSSL +## Important links +* [postmarketOS introduction](https://ollieparanoid.github.io/post/postmarketOS) +* [Security warning](https://ollieparanoid.github.io/post/security-warning/) +* [Porting progress](https://github.com/postmarketOS/pmbootstrap/wiki/Devices) + ## Usage **Check out the [porting guide](https://github.com/postmarketOS/pmbootstrap/wiki/Porting-to-a-new-device) for a practical start!** -**Porting progess: Wiki/[Devices](https://github.com/postmarketOS/pmbootstrap/wiki/Devices)** - Run `./pmbootstrap.py init` first, to select a target device and the work folder, which will contain all the chroots and other data. After that, you can run any command. All dependencies (e.g. chroots) will be installed automatically, if they are not available yet. @@ -49,3 +51,4 @@ Format and partition the SD card `/dev/mmcblk0`, and put a full postmarketOS ins ## Testsuite Simply install `pytest` (via your package manager or via pip) and run it inside the pmbootstrap folder. +