[PATCH docs] README: Add overview page with index

Andrew Jeffery andrew at aj.id.au
Tue Jan 19 11:23:51 AEDT 2016


On Mon, 2016-01-18 at 02:10 -0600, OpenBMC Patches wrote:
> 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

It'd be nice to make all of these relative links[1], so:

    [cheatsheet.md](cheetsheet.md): Quick ...

And so on for the remaining bullets

> +
> + - 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

Andrew

[1] https://github.com/blog/1395-relative-links-in-markup-files


More information about the openbmc mailing list