commit | a10f2d3bf7c63dd1c45636354c02a88bb41abb87 | [log] [tgz] |
---|---|---|
author | Gunnar Mills <gmills@us.ibm.com> | Wed Jul 05 15:13:27 2017 -0500 |
committer | Gunnar Mills <gmills@us.ibm.com> | Wed Jul 05 15:14:19 2017 -0500 |
tree | d9f39015ca7478e74a27cfc7d6bbb2392681703d | |
parent | a34373dc482fba4549e998870b3a0da2079dd7b3 [diff] |
Minor grammer fixes in contributing.md Change-Id: I9b2b200843f1228ddf92f60be41a10563eb0116f Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
This repository contains documentation for OpenBMC as a whole. There may be component-specific documentation in the repository for each component.
These documents describe how to use OpenBMC, including using the programmatic interfaces to an OpenBMC system.
rest-api.md: Introduction to using the OpenBMC REST API
console.md: Using the host console
host-management.md: Performing host management tasks with OpenBMC
code-update.md: Updating OpenBMC and host platform firmware
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
dbus-interfaces.md: Reference for APIs exposed to D-Bus
kernel-development.md: Reference for common kernel development tasks
The OpenBMC project's aim is to create a highly extensible framework for BMC software and implement for data-center computer systems.
We have a few high-level objectives:
The OpenBMC framework must be extensible, easy to learn, and usable in a variety of programming languages.
Provide a REST API for external management, and allow for "pluggable" interfaces for other types of management interactions.
Provide a remote host console, accessible over the network
Persist network configuration settable from REST interface and host
Provide a robust solution for RTC management, exposed to the host.
Compatible with host firmware implementations for basic IPMI communication between host and BMC
Provide a flexible and hierarchical inventory tracking component
Maintain a sensor database and track thresholds