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 15- List Archive: https://lore.kernel.org/openbmc/ 16- Discord: https://discord.gg/69Km47zH98 17- IRC: #openbmc on freenode.net 18 19## OpenBMC Development 20 21These documents contain details on developing OpenBMC code itself 22 23 - [cheatsheet.md](cheatsheet.md): Quick reference for some common 24 development tasks 25 26 - [CONTRIBUTING.md](CONTRIBUTING.md): Guidelines for contributing to 27 OpenBMC 28 29- [development tutorials](development/README.md): Tutorials for getting up to 30 speed on OpenBMC development 31 32 - [kernel-development.md](kernel-development.md): Reference for common 33 kernel development tasks 34 35## OpenBMC Usage 36 37These documents describe how to use OpenBMC, including using the programmatic 38interfaces to an OpenBMC system. 39 40 - [code-update](architecture/code-update): Updating OpenBMC and host platform firmware 41 42 - [console.md](console.md): Using the host console 43 44 - [host-management.md](host-management.md): Performing host management tasks 45 with OpenBMC 46 47 - [rest-api.md](rest-api.md): Introduction to using the OpenBMC REST API 48 49 - [REDFISH-cheatsheet.md](REDFISH-cheatsheet.md): Quick reference for some 50 common OpenBMC Redfish commands 51 52 - [REST-cheatsheet.md](REST-cheatsheet.md): Quick reference for some common 53 OpenBMC REST API commands 54