dev-environment: Fix example formatting

Use proper markdown with `obmcutil state` example,
also fix 'Note' formatting under that example.

Change-Id: I45dcaf282d422f6ab8a91e554ef75f6bcbb6633f
Signed-off-by: Alexander Amelkin <a.amelkin@yadro.com>
1 file changed
tree: 7a696ca7b67b05cbbf7ed06b123ff95a12e6f29f
  1. code-update/
  2. designs/
  3. development/
  4. logo/
  5. meetings/
  6. security/
  7. style/
  8. userguide/
  9. cheatsheet.md
  10. code-of-conduct.md
  11. console.md
  12. CONTRIBUTING.md
  13. cpp-style-and-conventions.md
  14. host-management.md
  15. ipmi-architecture.md
  16. kernel-development.md
  17. LED-architecture.md
  18. LICENSE
  19. maintainer-workflow.md
  20. MAINTAINERS
  21. Makefile
  22. object-mapper.md
  23. openbmc-conversion.md
  24. openbmc-systemd.md
  25. README.md
  26. REDFISH-cheatsheet.md
  27. release_process.md
  28. rest-api.md
  29. REST-cheatsheet.md
  30. run-test-docker.md
  31. sensor-architecture.md
  32. subtree.md
  33. user_management.md
  34. yocto-development.md
README.md

OpenBMC documentation

This repository contains documentation for OpenBMC as a whole. There may be component-specific documentation in the repository for each component.

OpenBMC Usage

These documents describe how to use OpenBMC, including using the programmatic interfaces to an OpenBMC system.

OpenBMC Development

These documents contain details on developing OpenBMC code itself

OpenBMC Goals

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

Technical Steering Committee

  • Brad Bishop (chair), IBM
  • Nancy Yuen, Google
  • Sai Dasari, Facebook
  • James Mihm, Intel
  • Ali Larijani, Microsoft