From nobody Wed May 1 23:08:38 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) client-ip=209.132.183.28; envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com; Authentication-Results: mx.zoho.com; spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; Return-Path: Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by mx.zohomail.com with SMTPS id 149546629876321.072289572473892; Mon, 22 May 2017 08:18:18 -0700 (PDT) Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com [10.5.11.13]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 470BC3DFCD; Mon, 22 May 2017 15:18:14 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 0B7D7783B5; Mon, 22 May 2017 15:18:14 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id 9646441F51; Mon, 22 May 2017 15:18:13 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id v4MFICV9013778 for ; Mon, 22 May 2017 11:18:12 -0400 Received: by smtp.corp.redhat.com (Postfix) id A1E875DD65; Mon, 22 May 2017 15:18:12 +0000 (UTC) Received: from t460.redhat.com (ovpn-117-9.ams2.redhat.com [10.36.117.9]) by smtp.corp.redhat.com (Postfix) with ESMTP id A1E0917AE5; Mon, 22 May 2017 15:18:09 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mx1.redhat.com 470BC3DFCD Authentication-Results: ext-mx05.extmail.prod.ext.phx2.redhat.com; dmarc=none (p=none dis=none) header.from=redhat.com Authentication-Results: ext-mx05.extmail.prod.ext.phx2.redhat.com; spf=pass smtp.mailfrom=libvir-list-bounces@redhat.com DKIM-Filter: OpenDKIM Filter v2.11.0 mx1.redhat.com 470BC3DFCD From: "Daniel P. Berrange" To: libvir-list@redhat.com Date: Mon, 22 May 2017 16:18:06 +0100 Message-Id: <20170522151806.27991-1-berrange@redhat.com> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 X-loop: libvir-list@redhat.com Subject: [libvirt] [PATCH v3] Provide a useful README file X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.29]); Mon, 22 May 2017 15:18:15 +0000 (UTC) X-ZohoMail: RSF_0 Z_629925259 SPT_0 Content-Type: text/plain; charset="utf-8" The current README file contents has almost no useful info, and that which does exist is very outdated. Signed-off-by: Daniel P. Berrange Reviewed-by: Andrea Bolognani --- Makefile.am | 1 + README | 14 +---------- README.md | 80 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++= ++++ 3 files changed, 82 insertions(+), 13 deletions(-) mode change 100644 =3D> 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 =3D \ autogen.sh \ cfg.mk \ run.in \ + README.md \ AUTHORS.in =20 pkgconfigdir =3D $(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 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 @@ +[![Build Status](https://travis-ci.org/libvirt/libvirt.svg)](https://travi= s-ci.org/libvirt/libvirt) + +Libvirt API for virtualization +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D + +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: + +* + +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=3D/usr --sysconfdir=3D/etc --localstatedir=3D/var +$ make +$ sudo make install +``` + +While to build & install as an unprivileged user + +``` +$ ./configure --prefix=3D$HOME/usr +$ make +$ make install +``` + + +The libvirt code relies on a large number of 3rd party libraries. These wi= ll +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 componen= ts +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 + +* + +Contact +------- + +The libvirt project has two primary mailing lists: + + * libvirt-users@redhat.com (**for user discussions**) + * libvir-list@redhat.com (**for development only**) + +Further details on contacting the project are available on the website + +* --=20 2.9.3 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list