[libvirt-dbus PATCH 3/9] README: Convert to reStructuredText
Signed-off-by: Andrea Bolognani <abologna(a)redhat.com>
---
README.md => README.rst | 37 +++++++++++++++++++------------------
1 file changed, 19 insertions(+), 18 deletions(-)
rename README.md => README.rst (68%)
diff --git a/README.md b/README.rst
similarity index 68%
rename from README.md
rename to README.rst
index 25534e4..eacbbf2 100644
--- a/README.md
+++ b/README.rst
@@ -1,3 +1,4 @@
+============
libvirt-dbus
============
@@ -12,40 +13,40 @@ API better suited for dbus-based applications.
libvirt-dbus is Free Software and licenced under LGPLv2+.
- * [https://libvirt.org/libvirt-dbus.html](https://libvirt.org/dbus.html)
+* https://libvirt.org/libvirt-dbus.html
The latest official releases can be found at:
- * [https://libvirt.org/sources/dbus/](https://libvirt.org/sources/dbus/)
+* https://libvirt.org/sources/dbus
Dependencies / supported platforms
-----------------------------------
+==================================
The packages required to build libvirt-dbus are
- - libvirt
- - libvirt-glib
- - glib2
+* libvirt
+* libvirt-glib
+* glib2
Installation
-------------
+============
libvirt-dbus uses Meson build system, so the build & install
process is fairly simple. For example, to install as root user:
-```
-# meson build --prefix=/usr --sysconfdir=/etc --localstatedir=/var
-# ninja -C build install
-```
+::
+
+ # meson build --prefix=/usr --sysconfdir=/etc --localstatedir=/var
+ # ninja -C build install
or to install as unprivileged user:
-```
-$ meson build --prefix=$HOME/usr
-$ ninja -C build install
-```
+::
+
+ $ meson build --prefix=$HOME/usr
+ $ ninja -C build install
Patches submissions
@@ -54,14 +55,14 @@ Patches submissions
Patch submissions are welcomed from any interested contributor. Please
send them to the main libvir-list mailing list
- * libvir-list(a)redhat.com
+* libvir-list(a)redhat.com
Questions about usage / deployment can be send to the end users mailing
list
- * libvirt-users(a)redhat.com
+* libvirt-users(a)redhat.com
For further information about mailing lists & contacting the developers,
please consult
-[https://libvirt.org/contact.html](https://libvirt.org/contact.html)
+https://libvirt.org/contact.html
--
2.25.3