README: Update
authorGeoff Levand <geoff@infradead.org>
Thu, 16 Aug 2018 17:30:08 +0000 (10:30 -0700)
committerSamuel Mendoza-Jonas <sam@mendozajonas.com>
Tue, 28 Aug 2018 03:45:49 +0000 (13:45 +1000)
Signed-off-by: Geoff Levand <geoff@infradead.org>
Signed-off-by: Samuel Mendoza-Jonas <sam@mendozajonas.com>
README.md

index bdb79f2ba8404e62454a67f454fec2ece6fd4f7b..8b50048666cb508c32373b413d7f75bcac23f493 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,22 +1,28 @@
 # Petitboot - A kexec-based bootloader
 
-Petitboot is a bootloader designed to run in a Linux environment for OPAL on PowerPC/POWER machines and the Playstation 3.
+Petitboot is an operating system bootloader based on Linux kexec.  It can load any operating system image that supports the Linux kexec re-boot mechanism like Linux and FreeBSD.
+Petitboot can load images from any device that can be mounted by Linux, and can also load images from the network using the HTTP, HTTPS, NFS, SFTP, and TFTP protocols.
 
-Development
--
+Current platform support includes PowerPC/POWER with OPAL, the Sony Playstation 3, and ARM64 with ACPI.  Petitboot can be built and run on other platforms, but it will not include all available features.
 
-Petitboot's home is at [ozlabs.org](http://git.ozlabs.org/?p=petitboot); clone it with ` git clone git://git.ozlabs.org/petitboot `
+See the petitboot [man pages](man) for more info.
 
-Development and discussion occurs on the Petitboot mailing list: [petitboot@lists.ozlabs.org](https://lists.ozlabs.org/listinfo/petitboot)
+## Development
 
-Building
--
+Petitboot's home is at [ozlabs.org](http://git.ozlabs.org/?p=petitboot); clone it with `git clone git://git.ozlabs.org/petitboot`.
 
-For an example of building Petitboot for distribution in a Linux image, see [op-build](https://github.com/open-power/op-build/tree/master/openpower/package/petitboot)
+Development and discussion occurs on the Petitboot mailing list: [petitboot@lists.ozlabs.org](https://lists.ozlabs.org/listinfo/petitboot).
+
+## Building
+
+For an example of building Petitboot for distribution in a Linux image, see [op-build](https://github.com/open-power/op-build/tree/master/openpower/package/petitboot) or [petitboot--buildroot](https://github.com/glevand/petitboot--buildroot).
 
 To build locally for development/debug (with the ncurses UI for example):
 ```
 ./bootstrap
-./configure --with-twin-x11=no --with-twin-fbdev=no
+./configure
 make
-```
\ No newline at end of file
+
+./discover/pb-discover --help
+./ui/ncurses/petitboot-nc --help
+```