summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorBeraldo Leal <bleal@redhat.com>2021-02-09 10:04:00 -0300
committerBeraldo Leal <bleal@redhat.com>2021-02-09 10:35:52 -0300
commitac2647f9587f50d8e15c88567b3dab2a087cea9d (patch)
tree84d3c624363d06511800fad02927cba69fe59bc1 /README
parent53065adece0c58a4c044daffe049aa25aac6854b (diff)
downloadlibvirt-python-ac2647f9587f50d8e15c88567b3dab2a087cea9d.tar.gz
improving readme with requirements
When installing this library in a fresh system, some basic packages are necessary to compile and run. This patch will add basic instructions with some requirements to help new contributors and users. Signed-off-by: Beraldo Leal <bleal@redhat.com>
Diffstat (limited to 'README')
-rw-r--r--README13
1 files changed, 11 insertions, 2 deletions
diff --git a/README b/README
index 96082f0..90f8b28 100644
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
- Libvirt Python Binding README
- =============================
+Libvirt Python Binding README
+=============================
This package provides a python binding to the libvirt.so,
libvirt-qemu.so and libvirt-lxc.so library APIs.
@@ -10,6 +10,15 @@ is 0.9.11 or newer.
This code is distributed under the terms of the LGPL version
2 or later.
+Requirements
+------------
+
+To build the libvirt python binary requires the GCC and pkg-config
+tools, and development headers for the libvirt and python libraries.
+
+Building and installing
+-----------------------
+
The module can be built by following the normal python module
build process