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 6The [features](features.md) document lists the project's major features 7with links to more information. 8 9 10OpenBMC Usage 11------------- 12 13These documents describe how to use OpenBMC, including using the programmatic 14interfaces to an OpenBMC system. 15 16 - [rest-api.md](rest-api.md): Introduction to using the OpenBMC REST API 17 18 - [console.md](console.md): Using the host console 19 20 - [host-management.md](host-management.md): Performing host management tasks 21 with OpenBMC 22 23 - [code-update](code-update): Updating OpenBMC and host platform firmware 24 25 26OpenBMC Development 27------------------- 28 29These documents contain details on developing OpenBMC code itself 30 31 - [cheatsheet.md](cheatsheet.md): Quick reference for some common 32 development tasks 33 34 - [CONTRIBUTING.md](CONTRIBUTING.md): Guidelines for contributing to 35 OpenBMC 36 37 - [kernel-development.md](kernel-development.md): Reference for common 38 kernel development tasks 39 40 - [REST-cheatsheet.md](REST-cheatsheet.md): Quick reference for some common 41 curl commands usage. 42 43 44OpenBMC Goals 45------------- 46 47The OpenBMC project's aim is to create a highly extensible framework for BMC 48software and implement for data-center computer systems. 49 50We have a few high-level objectives: 51 52 * The OpenBMC framework must be extensible, easy to learn, and usable in a 53 variety of programming languages. 54 55 * Provide a REST API for external management, and allow for "pluggable" 56 interfaces for other types of management interactions. 57 58 * Provide a remote host console, accessible over the network 59 60 * Persist network configuration settable from REST interface and host 61 62 * Provide a robust solution for RTC management, exposed to the host. 63 64 * Compatible with host firmware implementations for basic IPMI communication 65 between host and BMC 66 67 * Provide a flexible and hierarchical inventory tracking component 68 69 * Maintain a sensor database and track thresholds 70 71 72Technical Steering Committee 73--------------------------- 74 75 * Brad Bishop (chair), IBM 76 * Nancy Yuen, Google 77 * Sai Dasari, Facebook 78 * James Mihm, Intel 79 * Ali Larijani, Microsoft 80