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 17OpenBMC Development 18------------------- 19 20These documents contain details on developing OpenBMC code itself 21 22 - [cheatsheet.md](cheatsheet.md): Quick reference for some common 23 development tasks 24 25 - [contributing.md](contributing.md): Guidelines for contributing to 26 OpenBMC 27 28 - [dbus-interfaces.md](dbus-interfaces.md): Reference for APIs exposed 29 to dbus 30 31 - [kernel-development.md](kernel-development.md): Reference for common 32 kernel development tasks 33 34 35OpenBMC Goals 36------------- 37 38The OpenBMC project's aim is to create a highly extensible framework for BMC 39software and implement for data-center computer systems. 40 41We have a few high-level objectives: 42 43 * The OpenBMC framework must be extensible, easily to learn, and usable in a 44 variety of programming languages. 45 46 * Provide a REST API for external management, and allow for "pluggable" 47 interfaces for other types of management interactions. 48 49 * Provide a remote host console, accessible over the network 50 51 * Persist network configuration settable from REST interface and host 52 53 * Provide a robust solution for RTC management, exposed to the host. 54 55 * Compatible with host firmware implementations for basic IPMI communication 56 between host and BMC 57 58 * Provide a flexible and hierarchical inventory tracking component 59 60 * Maintain a sensor database and track thresholds 61