aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorChris Larson <clarson@kergoth.com>2003-09-20 03:17:55 +0000
committerChris Larson <clarson@kergoth.com>2003-09-20 03:17:55 +0000
commitfaeb6d363b9189cdbb34967f03e072865d9a6b00 (patch)
treec689d366c6783e58ced00cf437bc6f770f2bfbc8 /doc
parentb6e923ebdde838d42ee2f03995674c4b0a390e5f (diff)
downloadbitbake-faeb6d363b9189cdbb34967f03e072865d9a6b00.tar.gz
Add real, actual, content to README.
Diffstat (limited to 'doc')
-rw-r--r--doc/README65
1 files changed, 57 insertions, 8 deletions
diff --git a/doc/README b/doc/README
index 9fe7f26d9..1b685d567 100644
--- a/doc/README
+++ b/doc/README
@@ -1,12 +1,61 @@
-Contents
---------
+OpenEmbedded Build Infrastructure README
+--
-Misc documentation
+Project overview:
+(Note, the following is a high-level blurb, initial pass,
+which may refer to functionality that does not yet exist, but will
+by the time said blurb is advertised as fact.)
+OpenEmbedded is a full-featured development environment allowing
+users to target a wide variety of devices. Supporing multiple
+build, release paths, and configurations, OpenEmbedded extends the
+capabilities of your build and release engineers. OpenEmbedded
+uses compilation and configuration caching at most levels to improve
+developer efficiency.
-ebuild.*.txt
-------------
-Since I shape many things of OE like it is in Gentoo, here is the manpage
-of ebuild, Gentoo's build workhorse. It's for reference, we do some things
-differently.
+Basic operation:
+
+At its simplist, OpenEmbedded is a metadata management system, and
+multiple tools that make use of said data. What this comes down to,
+is a set of tools that manage builds and deployment in a single place,
+regardless of what target device, operating system, or packaging system
+we're building for.
+
+Assuming that you already have a .oe file or set of .oe files to utilize,
+the following applies:
+
+First, unless you installed an OE rpm, deb, or ipk, you'll want to set OEDIR
+to point to the OE repository that contains bin/classes and bin/oe.
+
+ cd oe
+ OEDIR=`pwd`
+ export OEDIR
+
+Next, for convenience, you'll want to add OEDIR/bin to your path.
+
+ PATH=$PATH:$OEDIR/bin
+
+Then, unless you're building natively (for the same architecture and operating
+system as you are building from), you'll want to customize conf/local.conf within
+the directory you'll be buliding from.
+
+ cd packages
+ echo 'TARGET_ARCH=arm' >> conf/local.conf
+
+Finally, you can start the build. There are a few ways to do so. First, you
+can run 'oebuild' on a single OE. Second, you can run oemake, which operates
+on an existing set of metadata, and will follow build dependencies.
+
+ oebuild content/glibc-2.3.2.oe
+ -or-
+ export OEFILES=`pwd`/content/*.oe
+ oemake glibc-2.3.2
+
+Please see the other files in doc/, as well as the --help output for each of the OE
+commands, for further details on the capabilities and use of the system.
+
+Thanks,
+
+Chris Larson - kergoth at handhelds dot org
+Embedded Linux Developer - clarson at ti dot com