openstack/virtualbmc
Code Issues Proposed changes

Update README

Browse Source 
The readme should reference to documentation.

Change-Id: I4fd4bf8a730067bbd11b6da0448ce65af3aa816f
Signed-off-by: Maciej Kucia <maciej@kucia.net>
This commit is contained in:
Maciej Kucia 2019-01-15 09:41:52 +01:00
parent 6c37c501bd
commit 90ac53067e
1 changed files with 24 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.rst
View File

@ -2,17 +2,27 @@
VirtualBMC
==========
Team and repository tags
------------------------
.. image:: https://governance.openstack.org/tc/badges/virtualbmc.svg
:target: https://governance.openstack.org/tc/reference/tags/index.html
Overview
--------
A virtual BMC for controlling virtual machines using IPMI commands.
Installation
------------
~~~~~~~~~~~~
.. code-block:: bash
pip install virtualbmc
Supported IPMI commands
-----------------------
~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: bash
@ -28,11 +38,18 @@ Supported IPMI commands
# Get the current boot device
ipmitool -I lanplus -U admin -P password -H 127.0.0.1 chassis bootparam get 5
Team and repository tags
------------------------
Project resources
~~~~~~~~~~~~~~~~~
.. image:: https://governance.openstack.org/tc/badges/virtualbmc.svg
:target: https://governance.openstack.org/tc/reference/tags/index.html
* Documentation: https://docs.openstack.org/virtualbmc/latest
* Source: https://git.openstack.org/cgit/openstack/virtualbmc
* Bugs: https://storyboard.openstack.org/#!/project/openstack/virtualbmc
* Release Notes: https://docs.openstack.org/releasenotes/virtualbmc/
.. Change things from this point on
Project status, bugs, and requests for feature enhancements (RFEs) are tracked
in StoryBoard:
https://storyboard.openstack.org/#!/project/openstack/virtualbmc
For information on how to contribute to VirtualBMC, see
https://docs.openstack.org/virtualbmc/latest/contributor