(no commit message)
[bitbake.git] / doc / README
1 OpenEmbedded Build Infrastructure README
2 --
3
4 Project overview:
5
6 (Note, the following is a high-level blurb, initial pass,
7 which may refer to functionality that does not yet exist, but will
8 by the time said blurb is advertised as fact.)
9
10 OpenEmbedded is a full-featured development environment allowing 
11 users to target a wide variety of devices.  Supporing multiple
12 build, release paths, and configurations, OpenEmbedded extends the
13 capabilities of your build and release engineers.  OpenEmbedded
14 uses compilation and configuration caching at most levels to improve
15 developer efficiency.
16
17 Basic operation:
18
19 At its simplist, OpenEmbedded is a metadata management system, and
20 multiple tools that make use of said data.  What this comes down to,
21 is a set of tools that manage builds and deployment in a single place,
22 regardless of what target device, operating system, or packaging system
23 we're building for.
24
25 Assuming that you already have a .oe file or set of .oe files to utilize,
26 the following applies:
27
28 First, unless you installed an OE rpm, deb, or ipk, you'll want to set OEDIR
29 to point to the OE repository that contains classes/ and bin/oe/.
30
31         cd oe
32         OEDIR=`pwd`
33         export OEDIR
34
35 Next, for convenience, you'll want to add OEDIR/bin to your path.
36
37         PATH=$PATH:$OEDIR/bin
38
39 Then, unless you're building natively (for the same architecture and operating
40 system as you are building from), you'll want to customize conf/local.conf within
41 the directory you'll be buliding from.
42
43         cd packages
44         echo 'TARGET_ARCH=arm' >> conf/local.conf
45  
46 Finally, you can start the build.  There are a few ways to do so.  First, you
47 can run 'oebuild' on a single OE.  Second, you can run oemake, which operates
48 on an existing set of metadata, and will follow build dependencies.
49
50         oebuild content/glibc_2.3.2.oe
51         -or-
52         export OEFILES=`pwd`/content/*.oe
53         oemake glibc_2.3.2
54
55 Please see the other files in doc/, as well as the --help output for each of the OE
56 commands, for further details on the capabilities and use of the system.
57
58 Thanks,
59
60 Chris Larson - kergoth at handhelds dot org
61 Embedded Linux Developer - clarson at ti dot com