[PATCH docs v2] README: Add overview page with index

Andrew Jeffery andrew at aj.id.au
Thu Jan 28 15:57:53 AEDT 2016


On Wed, 2016-01-27 at 21:00 -0600, OpenBMC Patches wrote:
> From: Jeremy Kerr <jk at ozlabs.org>
> 
> Signed-off-by: Jeremy Kerr <jk at ozlabs.org>

LGTM

Reviewed-by: Andrew Jeffery <andrew at aj.id.au>

> 
> --
> v2: Fix typo, add links to other docs.
> ---
>  README.md       | 20 +++++++++++++++++++-
>  contributing.md |  2 +-
>  2 files changed, 20 insertions(+), 2 deletions(-)
> 
> diff --git a/README.md b/README.md
> index 9b69328..c0bae54 100644
> --- a/README.md
> +++ b/README.md
> @@ -1 +1,19 @@
> -# 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](cheatsheet.md): Quick reference for some common
> +   development tasks
> +
> + - [contributing.md](contributing.md): Guidelines for contributing to
> +   OpenBMC
> +
> + - [dbus-interfaces.md](dbus-interfaces.md): Reference for APIs exposed
> +   to dbus
> +
> + - [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
> diff --git a/contributing.md b/contributing.md
> index a975983..08ae384 100644
> --- a/contributing.md
> +++ b/contributing.md
> @@ -11,7 +11,7 @@ Authors:
>  Structure
>  ---------
>  
> -OpenBMC has quite a module structure, consisting of small daemons with a
> +OpenBMC has quite a modular structure, consisting of small daemons with a
>  limited set of responsibilities. These communicate over dbus with other
>  components, to implement the complete BMC system.
>  


More information about the openbmc mailing list