Browse Source

Update README

The readme should reference to documentation.

Change-Id: I4fd4bf8a730067bbd11b6da0448ce65af3aa816f
Signed-off-by: Maciej Kucia <maciej@kucia.net>
Maciej Kucia 3 months ago
parent
commit
90ac53067e
1 changed files with 24 additions and 7 deletions
  1. 24
    7
      README.rst

+ 24
- 7
README.rst View File

@@ -2,17 +2,27 @@
2 2
 VirtualBMC
3 3
 ==========
4 4
 
5
+Team and repository tags
6
+------------------------
7
+
8
+.. image:: https://governance.openstack.org/tc/badges/virtualbmc.svg
9
+    :target: https://governance.openstack.org/tc/reference/tags/index.html
10
+
11
+Overview
12
+--------
13
+
5 14
 A virtual BMC for controlling virtual machines using IPMI commands.
6 15
 
7 16
 Installation
8
-------------
17
+~~~~~~~~~~~~
9 18
 
10 19
 .. code-block:: bash
11 20
 
12 21
   pip install virtualbmc
13 22
 
23
+
14 24
 Supported IPMI commands
15
------------------------
25
+~~~~~~~~~~~~~~~~~~~~~~~
16 26
 
17 27
 .. code-block:: bash
18 28
 
@@ -28,11 +38,18 @@ Supported IPMI commands
28 38
   # Get the current boot device
29 39
   ipmitool -I lanplus -U admin -P password -H 127.0.0.1 chassis bootparam get 5
30 40
 
31
-Team and repository tags
32
-------------------------
41
+Project resources
42
+~~~~~~~~~~~~~~~~~
33 43
 
34
-.. image:: https://governance.openstack.org/tc/badges/virtualbmc.svg
35
-    :target: https://governance.openstack.org/tc/reference/tags/index.html
44
+* Documentation: https://docs.openstack.org/virtualbmc/latest
45
+* Source: https://git.openstack.org/cgit/openstack/virtualbmc
46
+* Bugs: https://storyboard.openstack.org/#!/project/openstack/virtualbmc
47
+* Release Notes: https://docs.openstack.org/releasenotes/virtualbmc/
48
+
49
+Project status, bugs, and requests for feature enhancements (RFEs) are tracked
50
+in StoryBoard:
51
+https://storyboard.openstack.org/#!/project/openstack/virtualbmc
36 52
 
37
-.. Change things from this point on
53
+For information on how to contribute to VirtualBMC, see
54
+https://docs.openstack.org/virtualbmc/latest/contributor
38 55
 

Loading…
Cancel
Save