README.md: Add README file
authorSamuel Mendoza-Jonas <sam@mendozajonas.com>
Fri, 20 May 2016 07:01:44 +0000 (17:01 +1000)
committerSamuel Mendoza-Jonas <sam@mendozajonas.com>
Mon, 8 Aug 2016 03:52:50 +0000 (13:52 +1000)
Signed-off-by: Samuel Mendoza-Jonas <sam@mendozajonas.com>
README.md [new file with mode: 0644]

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..bdb79f2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# 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.
+
+Development
+-
+
+Petitboot's home is at [ozlabs.org](http://git.ozlabs.org/?p=petitboot); clone it with ` git clone git://git.ozlabs.org/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)
+
+To build locally for development/debug (with the ncurses UI for example):
+```
+./bootstrap
+./configure --with-twin-x11=no --with-twin-fbdev=no
+make
+```
\ No newline at end of file