[libvirt] [PATCH v3] Provide a useful README file

The current README file contents has almost no useful info, and that which does exist is very outdated. Signed-off-by: Daniel P. Berrange <berrange(a)redhat.com&gt; --- Makefile.am | 1 + README | 14 +---------- README.md | 80 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 82 insertions(+), 13 deletions(-) mode change 100644 => 120000 README create mode 100644 README.md diff --git a/Makefile.am b/Makefile.am index 333ec5a..db991ba 100644 --- a/Makefile.am +++ b/Makefile.am @@ -40,6 +40,7 @@ EXTRA_DIST = \ autogen.sh \ cfg.mk \ run.in \ + README.md \ AUTHORS.in pkgconfigdir = $(libdir)/pkgconfig diff --git a/README b/README deleted file mode 100644 index 3d5167d..0000000 --- a/README +++ /dev/null @@ -1,13 +0,0 @@ - - LibVirt : simple API for virtualization - - Libvirt is a C toolkit to interact with the virtualization capabilities -of recent versions of Linux (and other OSes). It is free software -available under the GNU Lesser General Public License. Virtualization of -the Linux Operating System means the ability to run multiple instances of -Operating Systems concurrently on a single hardware system where the basic -resources are driven by a Linux instance. The library aim at providing -long term stable C API initially for the Xen paravirtualization but -should be able to integrate other virtualization mechanisms if needed. - -Daniel Veillard <veillard(a)redhat.com&gt; diff --git a/README b/README new file mode 120000 index 0000000..42061c0 --- /dev/null +++ b/README @@ -0,0 +1 @@ +README.md \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..f5d4cd2 --- /dev/null +++ b/README.md @@ -0,0 +1,80 @@ +[](https://travis-ci.org... + +Libvirt API for virtualization +============================== + +Libvirt provides a portable, long term stable C API for managing the +virtualization technologies provided by many operating systems. It +includes support for QEMU, KVM, Xen, LXC, bhyve, Virtuozzo, VMware +vCenter and ESX, VMware Desktop, Hyper-V, VirtualBox and the POWER +Hypervisor. + +For some of these hypervisors, it provides a stateful management +daemon which runs on the virtualization host allowing access to the +API both by non-privileged local users and remote users. + +Layered packages provide bindings of the libvirt C API into other +languages including Python, Perl, PHP, Go, Java, OCaml, as well as +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> + +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.1 (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. For example, to build in a manner +that is suitable for installing as root, use: + +``` +$ ./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var +$ make +$ sudo make install +``` + +While to build & install as an unprivileged user + +``` +$ ./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 +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, using the `git send-email` command. Further guidance on this +can be found in the `HACKING` file, or the project website + +* <https://libvirt.org/contribute.html> + +Contact +------- + +The libvirt project has two primary mailing lists: + + * libvirt-users(a)redhat.com (**for user discussions**) + * libvir-list(a)redhat.com (**for development only**) + +Further details on contacting the project are available on the website + +* <https://libvirt.org/contact.html> -- 2.9.3