README | 81 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 71 insertions(+), 10 deletions(-)
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@redhat.com>
---
README | 81 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++---------
1 file changed, 71 insertions(+), 10 deletions(-)
diff --git a/README b/README
index 3d5167d..7103ae9 100644
--- a/README
+++ b/README
@@ -1,13 +1,74 @@
+ Libvirt API for virtualization
+ ==============================
- LibVirt : simple 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 PowerHyp.
- 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.
+For some of these hypervisors, it provides a stateful management
+daemon runs on the virtualization host allowing access to the API
+both by non-privileged local users and remote users.
-Daniel Veillard <veillard@redhat.com>
+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 restricted 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 normal 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) dependancies.
+
+Contributing
+============
+
+The libvirt project welcomes contributors from all. For most components
+the best way to contributor 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:
+
+ * libvir-list@redhat.com (for development)
+ * libvirt-users@redhat.com (for users)
+
+Further details on contacting the project are available on the website
+
+ https://libvirt.org/contact.html
+
+-- End
--
2.9.3
--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list
On Tue, May 16, 2017 at 11:50:27AM +0100, Daniel P. Berrange wrote: >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@redhat.com> >--- > README | 81 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++--------- > 1 file changed, 71 insertions(+), 10 deletions(-) > This is great and all, but if we are making this better, why not take the opportunity to use some plaintext format that has few features? I, personally, don't care whether that's org, markdown or rst. Just something that is still usable and readable as a plaintext file while it can be nicely formatted (with headers, links and images) on pages that support it (e.g. github). I know this seems like stupid wannabe modern tiny thing, but there are many nuances that can potentially influence future contributors. And I think this is one of the positive ones. Martin -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list
On Tue, May 16, 2017 at 01:54:30PM +0200, Martin Kletzander wrote: > On Tue, May 16, 2017 at 11:50:27AM +0100, Daniel P. Berrange wrote: > > 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@redhat.com> > > --- > > README | 81 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++--------- > > 1 file changed, 71 insertions(+), 10 deletions(-) > > > > This is great and all, but if we are making this better, why not take > the opportunity to use some plaintext format that has few features? I, > personally, don't care whether that's org, markdown or rst. Just > something that is still usable and readable as a plaintext file while it > can be nicely formatted (with headers, links and images) on pages that > support it (e.g. github). I know this seems like stupid wannabe modern > tiny thing, but there are many nuances that can potentially influence > future contributors. And I think this is one of the positive ones. Sure, I can do that. Regards, Daniel -- |: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :| -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list
© 2016 - 2024 Red Hat, Inc.