| commit | 7d0b8686e98f606d20c0bf393bfe1dd8c3cd3388 | [log] [tgz] |
|---|---|---|
| author | Andrew Jeffery <andrew@aj.id.au> | Wed Jan 16 23:31:27 2019 +1030 |
| committer | Andrew Jeffery <andrew@aj.id.au> | Wed Jan 16 23:31:27 2019 +1030 |
| tree | 1a13c0e7e06327f0464e36e856bbf3000a22f4b5 | |
| parent | 8eda385eb62646cb00e4c3af278e23456832cec3 [diff] |
meetings: mv README{,.md} to enable github markdown rendering
Change-Id: Ic756f5ab16eb6ecbc1e0d73544fe3324fc3a3bc9
Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
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