[contrib] Add README file to rom-o-matic
authorMarty Connor <mdc@etherboot.org>
Tue, 19 Jan 2010 02:37:14 +0000 (21:37 -0500)
committerMarty Connor <mdc@etherboot.org>
Tue, 19 Jan 2010 02:37:14 +0000 (21:37 -0500)
Signed-off-by: Marty Connor <mdc@etherboot.org>
contrib/rom-o-matic/README [new file with mode: 0644]

diff --git a/contrib/rom-o-matic/README b/contrib/rom-o-matic/README
new file mode 100644 (file)
index 0000000..1e9abbc
--- /dev/null
@@ -0,0 +1,62 @@
+ROM-o-matic web interface for building gPXE ROMs
+------------------------------------------------
+
+This web application generates gPXE images and sends them to a web
+browser.
+
+Available as part of the gPXE source code distribution, which can be
+downlaoded from http://etherboot.org/
+
+Author:  Marty Connor <mdc@etherboot.org>
+License: GPLv2
+Support: http://etherboot.org/mailman/listinfo/gpxe
+         Please send support questions to the gPXE mailing list
+
+System Requirements
+-------------------
+- Apache web server
+- PHP 4+
+- Tools required to build gPXE installed on the server
+  - gcc, mtools, syslinux, perl, etc.
+
+Setup
+-----
+As distributed, it is expected that the rom-o-matic source code
+directory is in the contrib directory of a gPXE source distribution.
+
+The easiest way to do this is to simply put a gPXE source distribution
+in a web server accessible directory.
+
+If this is not the case, you will need to either edit the file
+
+    "globals.php"
+
+or create a file called
+
+    "local-config.php"
+
+containing the following lines:
+
+<?php
+$src_dir = "../../src";
+?>
+
+Then change the line beginning "$src_dir = " to the path of your gPXE
+source code tree.
+
+To make build times shorter, before you run rom-o-matic for the first time
+you should cd to the gpxe "src" directory and enter the following
+commands:
+
+  $ make
+  $ make bin/NIC
+
+This will pro-compile most object files and will make your rom-o-matic
+builds much faster.
+
+Running rom-o-matic from a web browser
+--------------------------------------
+Enter a URL like:
+
+   http://example.com/gpxe-1.x.x/contrib/rom-o-matic
+