openbmc/docs/README.md

1 # OpenBMC documentation
3 The [OpenBMC project](https://www.openbmc.org/) is a Linux Foundation project
6 for OpenBMC as a whole. There may be component-specific documentation in the
14 - Mail: openbmc@lists.ozlabs.org https://lists.ozlabs.org/listinfo/openbmc
15 - List Archive: https://lore.kernel.org/openbmc/
18 ## OpenBMC Development
20 These documents contain details on developing OpenBMC code itself
25 - [CONTRIBUTING.md](CONTRIBUTING.md): Guidelines for contributing to OpenBMC
28   speed on OpenBMC development
33 ## OpenBMC Usage
35 These documents describe how to use OpenBMC, including using the programmatic
36 interfaces to an OpenBMC system.
38 - [code-update](architecture/code-update): Updating OpenBMC and host platform
44   with OpenBMC
46 - [rest-api.md](rest-api.md): Introduction to using the OpenBMC REST API
49   common OpenBMC Redfish commands
52   OpenBMC REST API commands