diff options
author | Andrew Geissler <geissonator@yahoo.com> | 2018-10-19 13:20:52 -0400 |
---|---|---|
committer | Gunnar Mills <gmills@us.ibm.com> | 2018-10-25 18:51:03 +0000 |
commit | 4614fd5950110b041b3f5645dbbd4e71d5482cee (patch) | |
tree | 48584a27655bd865f675fade7259883e8f38148c | |
parent | f600673d2df96bbba6228090ac3a84eaee5312d9 (diff) | |
download | openbmc-docs-4614fd5950110b041b3f5645dbbd4e71d5482cee.tar.gz openbmc-docs-4614fd5950110b041b3f5645dbbd4e71d5482cee.zip |
dev-doc: Add README to development directory
Provide a summary of each lesson and the recommended
order to read them
Change-Id: Iee33a13c80e10bb6ab9f39d232c41c3fb7e1ebcd
Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
-rw-r--r-- | development/README.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/development/README.md b/development/README.md new file mode 100644 index 0000000..f4e06e4 --- /dev/null +++ b/development/README.md @@ -0,0 +1,24 @@ +# OpenBMC Developer Documentation +This directory is focused on providing OpenBMC developers with the instructions +they need to get up and going with OpenBMC development. This can be reviewed in +any order you like, but the recommended flow can be found below. + +1. [Development Environment Setup](dev-environment.md) + + Start here. This shows how to setup an OpenBMC development environment using + its Software Development Kit and how to start the software emulator, QEMU. + +2. [Hello World](sdk-hello-world.md) + + This shows how to use the Software Development Kit as you build and test your + OpenBMC changes within QEMU. + +3. [Web UI Development](web-ui.md) + + This shows how to modify the phosphor-webui web application and test your + changes within QEMU. + +4. [Adding a New System](add-new-system.md) + + This shows how to create a new meta-machine layer which is the first step to + add support for your machine. |