diff options
| author | Jeremy Kerr <jk@ozlabs.org> | 2016-04-21 10:42:15 +0800 |
|---|---|---|
| committer | Jeremy Kerr <jk@ozlabs.org> | 2016-04-21 10:42:15 +0800 |
| commit | c16e3d0379088c19ec354259e4495f97533d12f5 (patch) | |
| tree | 686881f86dc2e02fa65e7ae984226e8fe223cc93 | |
| parent | 7acf2465fb905f83a63743ef5da64f8f7e6e1018 (diff) | |
| download | openbmc-docs-c16e3d0379088c19ec354259e4495f97533d12f5.tar.gz openbmc-docs-c16e3d0379088c19ec354259e4495f97533d12f5.zip | |
README: split contents into usage & development sections
Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
| -rw-r--r-- | README.md | 20 |
1 files changed, 16 insertions, 4 deletions
@@ -3,6 +3,22 @@ This repository contains documentation for OpenBMC as a whole. There may be component-specific documentation in the repository for each component. +OpenBMC Usage +------------- + +These documents describe how to use OpenBMC, including using the programmatic +interfaces to an OpenBMC system. + + - [rest-api.md](rest-api.md): Introduction to using the OpenBMC REST API + + - [console.md](console.md): Using the host console + + +OpenBMC Development +------------------- + +These documents contain details on developing OpenBMC code itself + - [cheatsheet.md](cheatsheet.md): Quick reference for some common development tasks @@ -15,7 +31,3 @@ be component-specific documentation in the repository for each component. - [kernel-development.md](kernel-development.md): Reference for common kernel development tasks - - [rest-api.md](rest-api.md): Introduction to using the OpenBMC REST - API - - - [console.md](console.md): Using the host console |

