1# OpenBMC documentation 2 3The [OpenBMC project](https://www.openbmc.org/) is a Linux Foundation project 4whose goal is to produce a customizable, open-source firmware stack for 5Baseboard Management Controllers (BMCs). This repository contains documentation 6for OpenBMC as a whole. There may be component-specific documentation in the 7repository for each component. 8 9The [features](features.md) document lists the project's major features 10with links to more information. 11 12## Contact 13 14- Mail: openbmc@lists.ozlabs.org [https://lists.ozlabs.org/listinfo/openbmc](https://lists.ozlabs.org/listinfo/openbmc) 15- IRC: #openbmc on freenode.net 16 17## OpenBMC Development 18 19These documents contain details on developing OpenBMC code itself 20 21 - [cheatsheet.md](cheatsheet.md): Quick reference for some common 22 development tasks 23 24 - [CONTRIBUTING.md](CONTRIBUTING.md): Guidelines for contributing to 25 OpenBMC 26 27- [development tutorials](development/README.md): Tutorials for getting up to 28 speed on OpenBMC development 29 30 - [kernel-development.md](kernel-development.md): Reference for common 31 kernel development tasks 32 33## OpenBMC Usage 34 35These documents describe how to use OpenBMC, including using the programmatic 36interfaces to an OpenBMC system. 37 38 - [code-update](code-update): Updating OpenBMC and host platform firmware 39 40 - [console.md](console.md): Using the host console 41 42 - [host-management.md](host-management.md): Performing host management tasks 43 with OpenBMC 44 45 - [rest-api.md](rest-api.md): Introduction to using the OpenBMC REST API 46 47 - [REDFISH-cheatsheet.md](REDFISH-cheatsheet.md): Quick reference for some 48 common OpenBMC Redfish commands 49 50 - [REST-cheatsheet.md](REST-cheatsheet.md): Quick reference for some common 51 OpenBMC REST API commands 52