commit | 711568995a81b72453203ae34c46428c57476265 | [log] [tgz] |
---|---|---|
author | Gunnar Mills <gmills@us.ibm.com> | Thu Dec 19 13:18:43 2019 -0600 |
committer | Gunnar Mills <gmills@us.ibm.com> | Wed Jan 15 21:02:11 2020 +0000 |
tree | 463c31b5c225aee66626c2c79d97e0b6a7332e29 | |
parent | 192bab2eb445d86d7d4608eba67312b0282c399a [diff] |
Improve README.md The README.md needs some work. Added an opening sentence, added a contact section, rearranged sections, reworded several sentences, removed the goals section since outdated and a broader goal is at the top. Change-Id: I33e8db68ff3e4300d2f861f1b21e64379e405349 Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
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.
The Technical Steering Committee (TSC) guides the project. Members are:
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