Improve README.md
The README.md needs some work. Added an opening sentence,
added a contact section, rearranged sections, reworded several
sentences, removed the goals section since outdated and a broader
goal is at the top.
Change-Id: I33e8db68ff3e4300d2f861f1b21e64379e405349
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
diff --git a/README.md b/README.md
index f118b67..76ff033 100644
--- a/README.md
+++ b/README.md
@@ -1,30 +1,31 @@
# OpenBMC documentation
-This repository contains documentation for OpenBMC as a whole. There may
-be component-specific documentation in the repository for each component.
+The [OpenBMC project](https://www.openbmc.org/) is a Linux Foundation project
+whose goal is to produce a customizable, open-source firmware stack for
+Baseboard Management Controllers (BMCs). This repository contains documentation
+for OpenBMC as a whole. There may be component-specific documentation in the
+repository for each component.
The [features](features.md) document lists the project's major features
with links to more information.
+## Contact
-OpenBMC Usage
--------------
+- Mail: openbmc@lists.ozlabs.org [https://lists.ozlabs.org/listinfo/openbmc](https://lists.ozlabs.org/listinfo/openbmc)
+- IRC: #openbmc on freenode.net
-These documents describe how to use OpenBMC, including using the programmatic
-interfaces to an OpenBMC system.
+## Technical Steering Committee
- - [rest-api.md](rest-api.md): Introduction to using the OpenBMC REST API
+The Technical Steering Committee (TSC) guides the project. Members are:
- - [console.md](console.md): Using the host console
+ * Brad Bishop (chair), IBM
+ * Nancy Yuen, Google
+ * Sai Dasari, Facebook
+ * James Mihm, Intel
+ * Sagar Dharia, Microsoft
+ * Supreeth Venkatesh, Arm
- - [host-management.md](host-management.md): Performing host management tasks
- with OpenBMC
-
- - [code-update](code-update): Updating OpenBMC and host platform firmware
-
-
-OpenBMC Development
--------------------
+## OpenBMC Development
These documents contain details on developing OpenBMC code itself
@@ -34,47 +35,28 @@
- [CONTRIBUTING.md](CONTRIBUTING.md): Guidelines for contributing to
OpenBMC
+- [development tutorials](development/README.md): Tutorials for getting up to
+ speed on OpenBMC development
+
- [kernel-development.md](kernel-development.md): Reference for common
kernel development tasks
+## OpenBMC Usage
+
+These documents describe how to use OpenBMC, including using the programmatic
+interfaces to an OpenBMC system.
+
+ - [code-update](code-update): Updating OpenBMC and host platform firmware
+
+ - [console.md](console.md): Using the host console
+
+ - [host-management.md](host-management.md): Performing host management tasks
+ with OpenBMC
+
+ - [rest-api.md](rest-api.md): Introduction to using the OpenBMC REST API
+
+ - [REDFISH-cheatsheet.md](REDFISH-cheatsheet.md): Quick reference for some
+ common OpenBMC Redfish commands
+
- [REST-cheatsheet.md](REST-cheatsheet.md): Quick reference for some common
- curl commands usage.
-
-
-OpenBMC Goals
--------------
-
-The OpenBMC project's aim is to create a highly extensible framework for BMC
-software and implement for data-center computer systems.
-
-We have a few high-level objectives:
-
- * The OpenBMC framework must be extensible, easy to learn, and usable in a
- variety of programming languages.
-
- * Provide a REST API for external management, and allow for "pluggable"
- interfaces for other types of management interactions.
-
- * Provide a remote host console, accessible over the network
-
- * Persist network configuration settable from REST interface and host
-
- * Provide a robust solution for RTC management, exposed to the host.
-
- * Compatible with host firmware implementations for basic IPMI communication
- between host and BMC
-
- * Provide a flexible and hierarchical inventory tracking component
-
- * Maintain a sensor database and track thresholds
-
-
-Technical Steering Committee
----------------------------
-
- * Brad Bishop (chair), IBM
- * Nancy Yuen, Google
- * Sai Dasari, Facebook
- * James Mihm, Intel
- * Sagar Dharia, Microsoft
- * Supreeth Venkatesh, Arm
+ OpenBMC REST API commands