summaryrefslogtreecommitdiff
path: root/README.in
diff options
context:
space:
mode:
authorChristophe Fergeau <cfergeau@redhat.com>2013-08-13 17:56:45 +0200
committerChristophe Fergeau <cfergeau@redhat.com>2013-08-13 18:40:29 +0200
commitd7730acae904b75c11664b4cf90a7653f94d9636 (patch)
treee6ffd12c51d4bad35805f7e4f0065545f64b76c8 /README.in
Import basic library framework
Signed-off-by: Christophe Fergeau <cfergeau@redhat.com>
Diffstat (limited to 'README.in')
-rw-r--r--README.in66
1 files changed, 66 insertions, 0 deletions
diff --git a/README.in b/README.in
new file mode 100644
index 0000000..32843f8
--- /dev/null
+++ b/README.in
@@ -0,0 +1,66 @@
+ libvirt Builder
+ ================
+
+The libvirt-builder package provides an API to bind together the
+libvirt-designer and libvirt-gobject APIs, to actually automate some
+of the lifecycle management and VM provisioning tasks.
+
+Installation
+------------
+
+The libvirt-builder package uses GNU autotools, so the build install
+process follows the standard process documented in the INSTALL file.
+As a quick start you can do
+
+ ./configure --prefix=/usr --sysconfdir=/etc \
+ --localstatedir=/var --libdir=/usr/lib
+ make
+ sudo make install
+
+Or to install into a private user specific location
+
+ ./configure --prefix=$HOME/libvirt-builder
+ make
+ make install
+
+The following mandatory dependencies are required in order to
+build libvirt-builder
+
+ libvirt-gconfig >= @LIBVIRT_GCONFIG_REQUIRED@ (part of libvirt-glib project releases)
+ libosinfo >= @LIBOSINFO_REQUIRED@
+
+
+Communication
+-------------
+
+To communicate with the development team, or to post patches
+there is a technical mailing list:
+
+ https://www.redhat.com/mailman/listinfo/libvir-list
+
+End user support can be found at
+
+ https://www.redhat.com/mailman/listinfo/libvirt-users
+
+There is also a mailing list for new release announcements:
+
+ https://www.redhat.com/mailman/listinfo/libvirt-announce
+
+Bugs found when using an OS distribution's binary packages should
+be reported to the OS vendors' own bug tracker first.
+
+The latest libvirt-builder code can be found in GIT at:
+
+ http://libvirt.org/git/?p=libvirt-builder.git
+
+Licensing
+---------
+
+libvirt-builder is provided under the terms of the GNU Lesser General
+Public License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+Please see the COPYING file for the complete LGPLv2+ license
+terms, or visit <http://www.gnu.org/licenses/>.
+
+-- End of readme