From 4614fd5950110b041b3f5645dbbd4e71d5482cee Mon Sep 17 00:00:00 2001 From: Andrew Geissler Date: Fri, 19 Oct 2018 13:20:52 -0400 Subject: 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 --- development/README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 development/README.md (limited to 'development/README.md') 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. -- cgit v1.2.1