xref: /openbmc/docs/README.md (revision b38b0a4c)
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
18## OpenBMC Development
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-  [development tutorials](development/README.md): Tutorials for getting up to
29   speed on OpenBMC development
30
31 - [kernel-development.md](kernel-development.md): Reference for common
32   kernel development tasks
33
34## OpenBMC Usage
35
36These documents describe how to use OpenBMC, including using the programmatic
37interfaces to an OpenBMC system.
38
39 - [code-update](architecture/code-update): Updating OpenBMC and host platform firmware
40
41 - [console.md](console.md): Using the host console
42
43 - [host-management.md](host-management.md): Performing host management tasks
44   with OpenBMC
45
46 - [rest-api.md](rest-api.md): Introduction to using the OpenBMC REST API
47
48 - [REDFISH-cheatsheet.md](REDFISH-cheatsheet.md): Quick reference for some
49   common OpenBMC Redfish commands
50
51 - [REST-cheatsheet.md](REST-cheatsheet.md): Quick reference for some common
52   OpenBMC REST API commands
53