diff options
| author | Alexander Amelkin <a.amelkin@yadro.com> | 2020-02-28 19:14:08 +0300 |
|---|---|---|
| committer | Andrew Geissler <geissonator@yahoo.com> | 2020-05-29 15:26:00 +0300 |
| commit | 5b59eee5b8ef3c294bcd3c45253ca550136a62a5 (patch) | |
| tree | a9cbcdebbde43ff1f92b15d9a71ea4d6ef40fbe5 /README.md | |
| parent | 8c06866b0123afe64ab529b829af9f2a26574e7e (diff) | |
| download | openbmc-5b59eee5b8ef3c294bcd3c45253ca550136a62a5.tar.xz | |
Update README.md to describe setup script
The `setup` script is there for quite a while but is still
not described in the README.md, so the documentation teaches
the users how to set up the environment the hard way.
This commit makes it easier for the newcomers to set up
the build environment.
Change-Id: I1901273246567ff2c211edb251f65106263daf6f
Signed-off-by: Alexander Amelkin <a.amelkin@yadro.com>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 46 |
1 files changed, 28 insertions, 18 deletions
@@ -35,30 +35,40 @@ cd openbmc ``` ### 3) Target your hardware -Any build requires an environment variable known as `TEMPLATECONF` to be set -to a hardware target. -You can see all of the known targets with -`find meta-* -name local.conf.sample`. Choose the hardware target and -then move to the next step. Additional examples can be found in the -[OpenBMC Cheatsheet](https://github.com/openbmc/docs/blob/master/cheatsheet.md) - -Machine | TEMPLATECONF ---------|--------- -Palmetto | ```meta-ibm/meta-palmetto/conf``` -Zaius| ```meta-ingrasys/meta-zaius/conf``` -Witherspoon| ```meta-ibm/meta-witherspoon/conf``` -Romulus| ```meta-ibm/meta-romulus/conf``` - - -As an example target Romulus +Any build requires an environment set up according to your hardware target. +There is a special script in the root of this repository that can be used +to configure the environment as needed. The script is called `setup` and +takes the name of your hardware target as an argument. + +The script needs to be sourced while in the top directory of the OpenBMC +repository clone, and, if run without arguments, will display the list +of supported hardware targets, see the following example: + +``` +$ . setup +Target machine must be specified. Use one of: + +centriq2400-rep nicole stardragon4800-rep2 +f0b olympus swift +fp5280g2 olympus-nuvoton tiogapass +gsj on5263m5 vesnin +hr630 palmetto witherspoon +hr855xg2 qemuarm witherspoon-128 +lanyang quanta-q71l witherspoon-tacoma +mihawk rainier yosemitev2 +msn romulus zaius +neptune s2600wf +``` + +Once you know the target (e.g. romulus), source the `setup` script as follows: + ``` -export TEMPLATECONF=meta-ibm/meta-romulus/conf +. setup romulus ``` ### 4) Build ``` -. openbmc-env bitbake obmc-phosphor-image ``` |