xref: /openbmc/docs/README.md (revision c16e3d03)
1# OpenBMC documentation
2
3This repository contains documentation for OpenBMC as a whole. There may
4be component-specific documentation in the repository for each component.
5
6OpenBMC Usage
7-------------
8
9These documents describe how to use OpenBMC, including using the programmatic
10interfaces to an OpenBMC system.
11
12 - [rest-api.md](rest-api.md): Introduction to using the OpenBMC REST API
13
14 - [console.md](console.md): Using the host console
15
16
17OpenBMC Development
18-------------------
19
20These documents contain details on developing OpenBMC code itself
21
22 - [cheatsheet.md](cheatsheet.md): Quick reference for some common
23   development tasks
24
25 - [contributing.md](contributing.md): Guidelines for contributing to
26   OpenBMC
27
28 - [dbus-interfaces.md](dbus-interfaces.md): Reference for APIs exposed
29   to dbus
30
31 - [kernel-development.md](kernel-development.md): Reference for common
32   kernel development tasks
33
34