Signed-off-by: Ján Tomko <jtomko@xxxxxxxxxx> --- README | 2 +- README.md => README.rst | 53 +++++++++++++++++++++-------------------- 2 files changed, 28 insertions(+), 27 deletions(-) rename README.md => README.rst (65%) diff --git a/README b/README index 42061c01a1..92cacd2853 120000 --- a/README +++ b/README @@ -1 +1 @@ -README.md \ No newline at end of file +README.rst \ No newline at end of file diff --git a/README.md b/README.rst similarity index 65% rename from README.md rename to README.rst index 44b0dd87c5..222ba55e78 100644 --- a/README.md +++ b/README.rst @@ -1,6 +1,11 @@ -[](https://travis-ci.org/libvirt/libvirt) - [](https://bestpractices.coreinfrastructure.org/projects/355) +.. image:: https://travis-ci.org/libvirt/libvirt.svg + :alt: Build Status + :target: https://travis-ci.org/libvirt/libvirt +.. image:: https://bestpractices.coreinfrastructure.org/projects/355/badge + :alt: CII Best Practices + :target: https://bestpractices.coreinfrastructure.org/projects/355 +============================== Libvirt API for virtualization ============================== @@ -21,60 +26,56 @@ mappings into object systems such as GObject, CIM and SNMP. Further information about the libvirt project can be found on the website: -[https://libvirt.org](https://libvirt.org) +https://libvirt.org License -------- +======= The libvirt C API is distributed under the terms of GNU Lesser General Public License, version 2.1 (or later). Some parts of the code that are not part of the C library may have the more restrictive GNU General -Public License, version 2.0 (or later). See the files `COPYING.LESSER` -and `COPYING` for full license terms & conditions. +Public License, version 2.0 (or later). See the files ``COPYING.LESSER`` +and ``COPYING`` for full license terms & conditions. Installation ------------- +============ Libvirt uses the GNU Autotools build system, so in general can be built and installed with the usual commands, however, we mandate to have the build directory different than the source directory. For example, to build -in a manner that is suitable for installing as root, use: +in a manner that is suitable for installing as root, use:: -``` -$ mkdir build && cd build -$ ../configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var -$ make -$ sudo make install -``` + $ mkdir build && cd build + $ ../configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var + $ make + $ sudo make install -While to build & install as an unprivileged user +While to build & install as an unprivileged user:: -``` -$ mkdir build && cd build -$ ../configure --prefix=$HOME/usr -$ make -$ make install -``` + $ mkdir build && cd build + $ ../configure --prefix=$HOME/usr + $ make + $ make install The libvirt code relies on a large number of 3rd party libraries. These will -be detected during execution of the `configure` script and a summary printed +be detected during execution of the ``configure`` script and a summary printed which lists any missing (optional) dependencies. Contributing ------------- +============ The libvirt project welcomes contributions in many ways. For most components the best way to contribute is to send patches to the primary development mailing list. Further guidance on this can be found on the website: -[https://libvirt.org/contribute.html](https://libvirt.org/contribute.html) +https://libvirt.org/contribute.html Contact -------- +======= The libvirt project has two primary mailing lists: @@ -83,4 +84,4 @@ The libvirt project has two primary mailing lists: Further details on contacting the project are available on the website: -[https://libvirt.org/contact.html](https://libvirt.org/contact.html) +https://libvirt.org/contact.html -- 2.25.1
