[PATCH docs] README: Add overview page with index

OpenBMC Patches openbmc-patches at stwcx.xyz
Mon Jan 18 19:10:08 AEDT 2016


From: Jeremy Kerr <jk at ozlabs.org>

Signed-off-by: Jeremy Kerr <jk at ozlabs.org>
---
 README.md | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 9b69328..689cd3d 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,14 @@
-# docs
+# OpenBMC documentation
+
+This repository contains documentation for OpenBMC as a whole. There may
+be component-specific documentation in the repository for each component.
+
+ - cheatsheet.md: Quick reference for some common development tasks
+
+ - contributing.md: Guidelines for contributing to OpenBMC
+
+ - dbus-interfaces.md: Reference for APIs exposed to dbus
+
+ - kernel-development.md: Reference for common kernel development tasks
+
+ - rest-api.md: Introduction to using the OpenBMC REST API
-- 
2.6.4




More information about the openbmc mailing list