| commit | 1a8a43836ea99d4607abacc8a7efdc9dd4142b32 | [log] [tgz] |
|---|---|---|
| author | Alexander Amelkin <alexander@amelkin.msk.ru> | Thu May 24 16:39:37 2018 +0300 |
| committer | Alexander Amelkin <a.amelkin@yadro.com> | Mon Jul 23 14:07:29 2018 +0300 |
| tree | e2017264e4755802e11a71ea9bbaf7ad9b55c0df | |
| parent | dfd6cae93416e013376d2d639f540d7a1585570a [diff] |
Make CONTRIBUTING.md all caps as per the Charter According to the official Charter at https://www.openbmc.org/wp-content/uploads/sites/62/2018/03/charter_openbmc_02142018.pdf the file must be named literally `CONTRIBUTING`. That is, all caps. This has been discussed in review comments for https://gerrit.openbmc-project.xyz/9948 Change-Id: I91697e89f9fcb812ad8928a62c4b6550e9e36291 Signed-off-by: Alexander Amelkin <a.amelkin@yadro.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: 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
kernel-development.md: Reference for common kernel development tasks
REST-cheatsheet.md: Quick reference for some common curl commands usage.
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