From nobody Fri May 3 12:34:53 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 205.139.110.120 as permitted sender) client-ip=205.139.110.120; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-1.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 205.139.110.120 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1586855483; cv=none; d=zohomail.com; s=zohoarc; b=UbbhTXlEeacOY5FaoCkIpV9AuTIuLU4Oz76Tynm1mvj/EakRvdKwbmeB0zzFc3Be76ZoV/QIgdxy4yxTCI60lL/O+wiDi2JVq67eBeBf2y1PpugTQG4CTvsRSE9sULDsGEhaTQzJk/Ji7GfhRofY7PwMvwahQod0AIoMPITNlps= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1586855483; h=Content-Type:Content-Transfer-Encoding:Date:From:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Sender:Subject:To; bh=N6CTH06sR14eg3/5ZpVI50wkOV2hUpNZA+cX+iIU8ys=; b=INsvmbnfjKupJ1ifzlhi/auQYREVqyL+u3+bmLr2IaSdYtAjokWBREljCm+HM7L/k2KZVURIIPbLe/+ToGU0LHLsF6bKrurL7v1g8vzfn+skkoHO8MOPWz451HP4Ie5bddx2QOVO+RMBpgY9J9K4kEAUP97eVPhtWyZH43YC+fE= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 205.139.110.120 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-1.mimecast.com (us-smtp-delivery-1.mimecast.com [205.139.110.120]) by mx.zohomail.com with SMTPS id 1586855483899812.068852588247; Tue, 14 Apr 2020 02:11:23 -0700 (PDT) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-296-eO5xPapFPaK9OoQUi4HMtw-1; Tue, 14 Apr 2020 05:11:19 -0400 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.phx2.redhat.com [10.5.11.22]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 955F9107ACCC; Tue, 14 Apr 2020 09:11:12 +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 BC36C10016EB; Tue, 14 Apr 2020 09:11:11 +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 329D693510; Tue, 14 Apr 2020 09:11:08 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 03E9B6bV017482 for ; Tue, 14 Apr 2020 05:11:06 -0400 Received: by smtp.corp.redhat.com (Postfix) id C78DC116D7B; Tue, 14 Apr 2020 09:11:06 +0000 (UTC) Received: from lpt.redhat.com (unknown [10.40.208.42]) by smtp.corp.redhat.com (Postfix) with ESMTP id D928F116D78 for ; Tue, 14 Apr 2020 09:11:03 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1586855482; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=N6CTH06sR14eg3/5ZpVI50wkOV2hUpNZA+cX+iIU8ys=; b=b8pA3IDL1CBmySkXq8FCI0AsvluhEijXdBpekt5+RuteMDXDASxT6uivRRmpoS386gF718 TTywATKYkKGMypK0CbOukBX1umRpuiwVKCYMObg4Ev+cqvDOm7G9oF80pOMUAIcuYz1y6o Vx7P6JlMbfK4B1d082alKLce5ozZuQU= X-MC-Unique: eO5xPapFPaK9OoQUi4HMtw-1 From: =?UTF-8?q?J=C3=A1n=20Tomko?= To: libvir-list@redhat.com Subject: [libvirt PATCH] README: rewrite in rst Date: Tue, 14 Apr 2020 11:11:00 +0200 Message-Id: <9fb0b47a9e1bca213089cc464349dee0915a57bb.1586855450.git.jtomko@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 X-loop: libvir-list@redhat.com 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: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.84 on 10.5.11.22 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) Content-Type: text/plain; charset="utf-8" Signed-off-by: J=C3=A1n Tomko Reviewed-by: Michal Privoznik --- README | 2 +- README.md =3D> README.rst | 53 +++++++++++++++++++++-------------------- 2 files changed, 28 insertions(+), 27 deletions(-) rename README.md =3D> README.rst (65%) diff --git a/README b/README index 42061c01a1..92cacd2853 120000 --- a/README +++ b/README @@ -1 +1 @@ -README.md \ No newline at end of file +README.rst \ No newline at end of file diff --git a/README.md b/README.rst similarity index 65% rename from README.md rename to README.rst index 44b0dd87c5..222ba55e78 100644 --- a/README.md +++ b/README.rst @@ -1,6 +1,11 @@ -[![Build Status](https://travis-ci.org/libvirt/libvirt.svg)](https://travi= s-ci.org/libvirt/libvirt) - [![CII Best Practices](https://bestpractices.coreinfrastructure.org/proje= cts/355/badge)](https://bestpractices.coreinfrastructure.org/projects/355) +.. image:: https://travis-ci.org/libvirt/libvirt.svg + :alt: Build Status + :target: https://travis-ci.org/libvirt/libvirt +.. image:: https://bestpractices.coreinfrastructure.org/projects/355/badge + :alt: CII Best Practices + :target: https://bestpractices.coreinfrastructure.org/projects/355 =20 +=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 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 =20 @@ -21,60 +26,56 @@ mappings into object systems such as GObject, CIM and S= NMP. Further information about the libvirt project can be found on the website: =20 -[https://libvirt.org](https://libvirt.org) +https://libvirt.org =20 =20 License -------- +=3D=3D=3D=3D=3D=3D=3D =20 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.0 (or later). See the files `COPYING.LESSER` -and `COPYING` for full license terms & conditions. +Public License, version 2.0 (or later). See the files ``COPYING.LESSER`` +and ``COPYING`` for full license terms & conditions. =20 =20 Installation ------------- +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 Libvirt uses the GNU Autotools build system, so in general can be built and installed with the usual commands, however, we mandate to have the build directory different than the source directory. For example, to build -in a manner that is suitable for installing as root, use: +in a manner that is suitable for installing as root, use:: =20 -``` -$ mkdir build && cd build -$ ../configure --prefix=3D/usr --sysconfdir=3D/etc --localstatedir=3D/var -$ make -$ sudo make install -``` + $ mkdir build && cd build + $ ../configure --prefix=3D/usr --sysconfdir=3D/etc --localstatedir=3D/v= ar + $ make + $ sudo make install =20 -While to build & install as an unprivileged user +While to build & install as an unprivileged user:: =20 -``` -$ mkdir build && cd build -$ ../configure --prefix=3D$HOME/usr -$ make -$ make install -``` + $ mkdir build && cd build + $ ../configure --prefix=3D$HOME/usr + $ make + $ make install =20 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 print= ed +be detected during execution of the ``configure`` script and a summary pri= nted which lists any missing (optional) dependencies. =20 =20 Contributing ------------- +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 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. Further guidance on this can be found on the website: =20 -[https://libvirt.org/contribute.html](https://libvirt.org/contribute.html) +https://libvirt.org/contribute.html =20 =20 Contact -------- +=3D=3D=3D=3D=3D=3D=3D =20 The libvirt project has two primary mailing lists: =20 @@ -83,4 +84,4 @@ The libvirt project has two primary mailing lists: =20 Further details on contacting the project are available on the website: =20 -[https://libvirt.org/contact.html](https://libvirt.org/contact.html) +https://libvirt.org/contact.html --=20 2.25.1