|author||Chris Austen <firstname.lastname@example.org>||2017-01-27 15:22:29 -0600|
|committer||Patrick Williams <email@example.com>||2017-01-31 22:29:31 +0000|
Additional details to README.md
Spruce up the README file to include high level information about 1. Who we are 2. How to build 3. What we do 4. How to seek help Change-Id: I8a515d291884749b2cd5dca5f67b3c6a63683975 Signed-off-by: Chris Austen <firstname.lastname@example.org>
Diffstat (limited to 'README.md')
1 files changed, 89 insertions, 13 deletions
@@ -2,23 +2,99 @@
-## Building ##
+The OpenBMC project can be described as a Linux distribution for embedded
+devices that have a BMC; typically, but not limited to, things like servers,
+top of rack switches or RAID appliances. The OpenBMC stack uses technologies
+such as Yocto, Open-Embedded, Systemd and DBus to allow easy customization
+for your server platform.
-OpenBMC uses Yocto/Open-Embedded for a build system, which supports an
-out-of-tree build. It is recommended that you create an empty directory
-somewhere to hold the build. This directory will get big.
-On Ubuntu 14.04 the following packages are required to build the default target
+## Setting up your OpenBMC project ##
- sudo apt-get install -y git build-essential libsdl1.2-dev texinfo gawk chrpath diffstat
+### 1) Prerequisite ###
+- Ubuntu 14.04
-On Fedora 23 the following packages are required to build the default target:
+sudo apt-get install -y git build-essential libsdl1.2-dev texinfo gawk chrpath diffstat
- sudo dnf install -y git patch diffstat texinfo chrpath SDL-devel bitbake
- sudo dnf groupinstall "C Development Tools and Libraries"
+- Fedora 23
-To start a build:
+sudo dnf install -y git patch diffstat texinfo chrpath SDL-devel bitbake
+sudo dnf groupinstall "C Development Tools and Libraries"
+### 2) Download the source ###
+git clone email@example.com:openbmc/openbmc.git
- cd <builddir>
- . <repodir>/openbmc-env
- bitbake obmc-phosphor-image
+### 3) Target your hardware ###
+Any build requires an environment variable known as `TEMPLATECONF` to be set
+to a hardware target. OpenBMC has placed all known hardware targets in a
+standard directory structure `meta-openbmc-machines/meta-openpower/[company]/[target]`.
+You can see all of the known targets with `find meta-openbmc-machines -type d -name conf`.
+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-openbmc-machines/meta-openpower/meta-ibm/meta-palmetto/conf```
+Barreleye | ```meta-openbmc-machines/meta-openpower/meta-rackspace/meta-barreleye/conf```
+As an example target Palmetto
+### 3) Build ###
+Additional details can be found in the [docs](https://github.com/openbmc/docs)
+## Build Validation and Testing ##
+Commits submitted by members of the OpenBMC Github community are compiled and
+tested via our [Jenkins](https://openpower.xyz/) server. Commits are run
+through two levels of testing. At the repository level the makefile `make
+check` directive is run. At the system level, the commit is built into a
+firmware image and run with a arm-softmmu QEMU model against a barrage of
+Commits submitted by non-members do not automatically proceed through CI
+testing. After visual inspection of the commit, a CI run can be manually
+performed by the reviewer.
+Automated testing against the QEMU model along with supported systems are
+performed. The OpenBMC project uses the [Robot Framework]
+(http://robotframework.org/) for all automation. Our complete test
+repository can be found [here](https://github.com/openbmc/openbmc-test-automation).
+## Submitting Patches ##
+Support of additional hardware and software packages is always welcome.
+Please follow the [contributing guidelines](https://github.com/openbmc/docs/blob/master/contributing.md)
+when making a submission. It is expected that contributions contain test
+## Bug Reporting ##
+[Issues](https://github.com/openbmc/openbmc/issues) are managed on
+Github. It is recommended you search through the issues before opening
+a new one.
+## Finding out more ##
+Dive deeper in to OpenBMC by opening the [docs](https://github.com/openbmc/docs)
+## Contact ##
+- Mail: firstname.lastname@example.org [https://lists.ozlabs.org/listinfo/openbmc]
+- IRC: #openbmc on freenode.net
+- Riot: [#openbmc:matrix.org](https://riot.im/app/#/room/#openbmc:matrix.org)