Web   ·   Wiki   ·   Activities   ·   Blog   ·   Lists   ·   Chat   ·   Meeting   ·   Bugs   ·   Git   ·   Translate   ·   Archive   ·   People   ·   Donate
summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDaniel Drake <dsd@laptop.org>2011-01-26 18:47:05 (GMT)
committer Daniel Drake <dsd@laptop.org>2011-01-26 18:47:05 (GMT)
commit67d4be756c1204e78451880f3e2ec93bcb415288 (patch)
treece1325e72d74b8fcf4a0297f17d5b24730c5c61b /doc
parentf7a8e9e8ebfa6c140fb8d4af45dc302e2a610622 (diff)
Update documentation for Fedora inclusion
Diffstat (limited to 'doc')
-rw-r--r--doc/README20
-rw-r--r--doc/README.devel31
2 files changed, 37 insertions, 14 deletions
diff --git a/doc/README b/doc/README
index d3f3c90..16e6d4f 100644
--- a/doc/README
+++ b/doc/README
@@ -7,23 +7,15 @@ Quick Start:
1. install Fedora 14,
- 2. install the build dependencies:
+ 2. install the build package:
- yum install zlib-devel libtomcrypt-devel glibc-headers
+ yum install olpc-os-builder
- 3. build the package:
+ 3. produce a build:
- make install
+ olpc-os-builder /usr/share/doc/olpc-os-builder-*/examples/f14-xo1.5.ini
- 4. install the run-time dependencies:
-
- yum install python-imgcreate bitfrost zip unzip crcimg mtd-utils mtd-utils-ubi
-
- 5. produce a build:
-
- olpc-os-builder examples/f14-xo1.5.ini
-
- 6. view or use the build result files:
+ 4. view or use the build result files:
ls -l /var/tmp/olpc-os-builder
@@ -31,7 +23,7 @@ Quick Start:
Description:
The build is made based from a build configuration, which selects a
-series of modules which were installed by olpc-image-builder. These
+series of modules which were installed by olpc-os-builder. These
modules (and the configuration you provide) control the outcome of the
build process.
diff --git a/doc/README.devel b/doc/README.devel
index cc2a195..3b2d456 100644
--- a/doc/README.devel
+++ b/doc/README.devel
@@ -1,6 +1,37 @@
+== GETTING STARTED ==
+
Git repo: git://dev.laptop.org/git/projects/olpc-os-builder
Mailing list: http://lists.laptop.org/listinfo/devel
+olpc-os-builder can be run in "uninstalled mode" from a standard git
+checkout.
+
+ 1. Install build and run-time dependencies
+
+ These can be found in the olpc-os-builder.spec file in Fedora GIT. Instead
+ of going to the hassle to look them up, you could just run:
+
+ yum install olpc-os-builder
+
+ This will ensure that all dependencies are present, and having a systemwide
+ installation of olpc-os-builder will in no way affect your "uninstalled"
+ version.
+
+ 2. Build the relevant binaries, from the git checkout:
+
+ make
+
+ 3. Produce a build: (must be run as root)
+
+ ./osbuilder.py examples/f14-xo1.5.ini
+
+ 4. View and use build result files:
+
+ ls -l build/output
+
+
+== DESIGN ==
+
olpc-os-builder is composed of a series of modules, and an INI-style
configuration supplied by the user, which selects the modules to be used
and any settings to apply to them.