commit | 33b252952a718d47fcd0951c6047765feb66203b | [log] [tgz] |
---|---|---|
author | Andrew Jeffery <andrew@aj.id.au> | Mon Jul 25 10:54:49 2022 +0930 |
committer | Patrick Williams <patrick@stwcx.xyz> | Tue Jul 26 15:43:58 2022 +0000 |
tree | 334f03a901bdfa76e07de5484f2f70b85df007d5 | |
parent | e2430b15af7752582d5743bb7af655d1fd52305f [diff] |
design-template: Organise guidelines Add some sub-headers and rename the section to "Document Guidelines". Do the rename because the section is guiding you on when/how to write the document, not how to design your thingo. Change-Id: Iddf5540e80d5af00c9ef49bd1f7077cd4dfdddaa Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
The OpenBMC project is a Linux Foundation project whose goal is to produce a customizable, open-source firmware stack for Baseboard Management Controllers (BMCs). This repository contains documentation for OpenBMC as a whole. There may be component-specific documentation in the repository for each component.
The features document lists the project's major features with links to more information.
These documents contain details on developing OpenBMC code itself
cheatsheet.md: Quick reference for some common development tasks
CONTRIBUTING.md: Guidelines for contributing to OpenBMC
development tutorials: Tutorials for getting up to speed on OpenBMC development
kernel-development.md: Reference for common kernel development tasks
These documents describe how to use OpenBMC, including using the programmatic interfaces to an OpenBMC system.
code-update: Updating OpenBMC and host platform firmware
console.md: Using the host console
host-management.md: Performing host management tasks with OpenBMC
rest-api.md: Introduction to using the OpenBMC REST API
REDFISH-cheatsheet.md: Quick reference for some common OpenBMC Redfish commands
REST-cheatsheet.md: Quick reference for some common OpenBMC REST API commands