1# OpenBMC documentation 2 3This repository contains documentation for OpenBMC as a whole. There may 4be component-specific documentation in the repository for each component. 5 6OpenBMC Usage 7------------- 8 9These documents describe how to use OpenBMC, including using the programmatic 10interfaces to an OpenBMC system. 11 12 - [rest-api.md](rest-api.md): Introduction to using the OpenBMC REST API 13 14 - [console.md](console.md): Using the host console 15 16 - [code-update.md](code-update.md): Updating OpenBMC and host platform firmware 17 18 19OpenBMC Development 20------------------- 21 22These documents contain details on developing OpenBMC code itself 23 24 - [cheatsheet.md](cheatsheet.md): Quick reference for some common 25 development tasks 26 27 - [contributing.md](contributing.md): Guidelines for contributing to 28 OpenBMC 29 30 - [dbus-interfaces.md](dbus-interfaces.md): Reference for APIs exposed 31 to dbus 32 33 - [kernel-development.md](kernel-development.md): Reference for common 34 kernel development tasks 35 36 37OpenBMC Goals 38------------- 39 40The OpenBMC project's aim is to create a highly extensible framework for BMC 41software and implement for data-center computer systems. 42 43We have a few high-level objectives: 44 45 * The OpenBMC framework must be extensible, easily to learn, and usable in a 46 variety of programming languages. 47 48 * Provide a REST API for external management, and allow for "pluggable" 49 interfaces for other types of management interactions. 50 51 * Provide a remote host console, accessible over the network 52 53 * Persist network configuration settable from REST interface and host 54 55 * Provide a robust solution for RTC management, exposed to the host. 56 57 * Compatible with host firmware implementations for basic IPMI communication 58 between host and BMC 59 60 * Provide a flexible and hierarchical inventory tracking component 61 62 * Maintain a sensor database and track thresholds 63