Skip to content

Commit e5ae24b

Browse files
committed
Provide a useful README file
The current README file contents has almost no useful info, and that which does exist is very outdated. Reviewed-by: Andrea Bolognani <abologna@redhat.com> Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
1 parent 9b991d0 commit e5ae24b

File tree

3 files changed

+86
-13
lines changed

3 files changed

+86
-13
lines changed

Makefile.am

+1
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ EXTRA_DIST = \
4040
autogen.sh \
4141
cfg.mk \
4242
run.in \
43+
README.md \
4344
AUTHORS.in
4445

4546
pkgconfigdir = $(libdir)/pkgconfig

README

-13
This file was deleted.

README

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
README.md

README.md

+84
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
[![Build Status](https://travis-ci.org/libvirt/libvirt.svg)](https://travis-ci.org/libvirt/libvirt)
2+
3+
Libvirt API for virtualization
4+
==============================
5+
6+
Libvirt provides a portable, long term stable C API for managing the
7+
virtualization technologies provided by many operating systems. It
8+
includes support for QEMU, KVM, Xen, LXC, bhyve, Virtuozzo, VMware
9+
vCenter and ESX, VMware Desktop, Hyper-V, VirtualBox and the POWER
10+
Hypervisor.
11+
12+
For some of these hypervisors, it provides a stateful management
13+
daemon which runs on the virtualization host allowing access to the
14+
API both by non-privileged local users and remote users.
15+
16+
Layered packages provide bindings of the libvirt C API into other
17+
languages including Python, Perl, PHP, Go, Java, OCaml, as well as
18+
mappings into object systems such as GObject, CIM and SNMP.
19+
20+
Further information about the libvirt project can be found on the
21+
website:
22+
23+
* <https://libvirt.org>
24+
25+
26+
License
27+
-------
28+
29+
The libvirt C API is distributed under the terms of GNU Lesser General
30+
Public License, version 2.1 (or later). Some parts of the code that are
31+
not part of the C library may have the more restrictive GNU General
32+
Public License, version 2.1 (or later). See the files COPYING.LESSER
33+
and COPYING for full license terms & conditions.
34+
35+
36+
Installation
37+
------------
38+
39+
Libvirt uses the GNU Autotools build system, so in general can be built
40+
and installed with the usual commands. For example, to build in a manner
41+
that is suitable for installing as root, use:
42+
43+
```
44+
$ ./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var
45+
$ make
46+
$ sudo make install
47+
```
48+
49+
While to build & install as an unprivileged user
50+
51+
```
52+
$ ./configure --prefix=$HOME/usr
53+
$ make
54+
$ make install
55+
```
56+
57+
58+
The libvirt code relies on a large number of 3rd party libraries. These will
59+
be detected during execution of the configure script and a summary printed
60+
which lists any missing (optional) dependencies.
61+
62+
63+
Contributing
64+
------------
65+
66+
The libvirt project welcomes contributions in many ways. For most components
67+
the best way to contribute is to send patches to the primary development
68+
mailing list, using the `git send-email` command. Further guidance on this
69+
can be found in the `HACKING` file, or the project website
70+
71+
* <https://libvirt.org/contribute.html>
72+
73+
74+
Contact
75+
-------
76+
77+
The libvirt project has two primary mailing lists:
78+
79+
* libvirt-users@redhat.com (**for user discussions**)
80+
* libvir-list@redhat.com (**for development only**)
81+
82+
Further details on contacting the project are available on the website
83+
84+
* <https://libvirt.org/contact.html>

0 commit comments

Comments
 (0)