summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJeremy Kerr <jk@ozlabs.org>2016-04-21 10:42:15 +0800
committerJeremy Kerr <jk@ozlabs.org>2016-04-21 10:42:15 +0800
commitc16e3d0379088c19ec354259e4495f97533d12f5 (patch)
tree686881f86dc2e02fa65e7ae984226e8fe223cc93
parent7acf2465fb905f83a63743ef5da64f8f7e6e1018 (diff)
downloadopenbmc-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.md20
1 files changed, 16 insertions, 4 deletions
diff --git a/README.md b/README.md
index bc76825..ccc802d 100644
--- a/README.md
+++ b/README.md
@@ -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
OpenPOWER on IntegriCloud