Update README file contents and add HACKING file

The previous README file from the python code is more like a
HACKING file. Rename it and update the content. Then add a
basic README file

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

1 files changed, 30 insertions, 20 deletions

diff --git a/README b/README
index 02d4cc4..ad50828 100644
--- a/README
+++ b/README
@@ -1,27 +1,37 @@
-    libvirt Python Bindings README
-    ==============================
+     Libvirt Python Binding README
+     =============================
 
-Most of the libvirt python binding code is automatically generated
-using the script  generator.py, and the API description from
-docs/libvirt-api.xml
+This package provides a python binding to the libvirt.so,
+libvirt-qemu.so and libvirt-lxc.so library APIs.
 
+It is written to build against any version of libvirt that
+is 0.9.11 or newer.
 
-Manually written files:
+This code is distributed under the terms of the LGPL version
+2 or later.
 
- - libvirt-override.c: methods where the C binding needs to be hand crafted
- - libvirt-override.py: global methods where the C and python bindings have different args
- - libvirt-override-api.xml: methods where the auto-extracted API docs are not
-   suitable for python auto-generator. Overriding this if the method is going
-   into libvirt-override.c, but we still want auto-generated libvirt-override.py
- - libvirt-override-virConnect.py: virConnect class methods
- - typewrappers.h,.c: Python object wrappers for each libvirt C object
+The module can be built by following the normal python module
+build process
 
+  python setup.py build
+  sudo python setup.py install
 
-Auto-generated files:
+or to install as non-root
 
-  - libvirt.py: The main python binding. Comprises auto-generated code, along
-    with contents from libvirt-override.py and libvirt-override-virConnect.py
-  - libvirt.c, libvirt.h: The C glue layer for the python binding. Comprises
-    auto-generated code, along with libvirt-override.c
-  - libvirt-export.c: List of auto-generated C methods, included into
-    the libvirt-override.c method table
+  python setup.py build
+  python setup.py install --user
+
+
+Patches for this code should be sent to the main libvirt
+development mailing list
+
+  http://libvirt.org/contact.html#email
+
+To send patches, it is strongly recommended to use the
+'git send-email' command.
+
+Make sure the mails mention that the patch is for the python
+binding. This can be done by setting a config parameter in the
+local git checkout
+
+  git config format.subjectprefix "PATCH python"