README: Update
diff mbox series

Message ID 733b0cff-1853-b398-6789-1db004efe0bd@infradead.org
State Accepted
Headers show
Series
  • README: Update
Related show

Commit Message

Geoff Levand Aug. 16, 2018, 5:30 p.m. UTC
Signed-off-by: Geoff Levand <geoff@infradead.org>
---
Hi Sam,

Added mention of arm64, and a general cleanup.  Please consider.

-Geoff

 README.md | 26 ++++++++++++++++----------
 1 file changed, 16 insertions(+), 10 deletions(-)

Comments

Samuel Mendoza-Jonas Aug. 28, 2018, 7 a.m. UTC | #1
On Thu, 2018-08-16 at 10:30 -0700, Geoff Levand wrote:
> Signed-off-by: Geoff Levand <geoff@infradead.org>
> ---
> Hi Sam,
> 
> Added mention of arm64, and a general cleanup.  Please consider.
> 
> -Geoff

Thanks, merged as 54fe42bb.

> 
>  README.md | 26 ++++++++++++++++----------
>  1 file changed, 16 insertions(+), 10 deletions(-)
> 
> diff --git a/README.md b/README.md
> index bdb79f2..8b50048 100644
> --- 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
> +```

Patch
diff mbox series

diff --git a/README.md b/README.md
index bdb79f2..8b50048 100644
--- 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
+```