From 56e5599069cd084e3a2792566d07b566be495494 Mon Sep 17 00:00:00 2001 From: "Michael S. Tsirkin" Date: Wed, 25 Sep 2019 07:40:14 -0400 Subject: README.md: clean up build instructions Switch to
from manual formatting with
and

. Clarify wording a bit. Add hints on what to do in case of missing fonts. Signed-off-by: Michael S. Tsirkin --- README.md | 56 +++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 37 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 5ac84f9..96d41c0 100644 --- a/README.md +++ b/README.md @@ -30,33 +30,51 @@

Further Description of this Repository

Building Instructions

-

In order to build the spec you will need Tex-Live. -Installing it can be done via:
-Fedora: +Authoritative version of the specification is maintained in the +TeX document format. PDF and HTML versions are made available for +ease of use and review. +In order to build the HTML and PDF versions of the spec you will need the + TeX document production system. +The easiest way to get it up and running is probably by installing +Tex-Live. + +

Installation cheat sheet: +
Fedora:
+
sudo dnf install texlive-scheme-full -
-Ubuntu: +
+
+Ubuntu and other Debian derivatives: +
+
sudo apt-get install texlive-full -

-

OSX users don't need to install Tex-Live because they already have +

+
OSX:
+
OSX users don't need to install Tex-Live because they already have MacTex installed. - -

The building proccess is done with +

+
+
The build process generates a ZIP package file including the +original TeX sources, as well as HTML and PDF formatted +versions of the specification. +
To generate the ZIP package, run:
+
./makeall.sh -and it contains 3 main parts: - -makezip.sh -, - -makehtml.sh -, - -makepdf.sh -. +
+
Troubleshooting notes:
+
PDFs of the specification can be generated with +either MicroSoft's Core fonts for the Web: Arial and Courier New, +or Liberation fonts: Liberation Sans and Liberation Mono. +Most systems come with one of these two variants included: +should you get an error message about missing fonts, +you will need to downloads and install one of the above +font packages. +
+

Providing Feedback

Feedback must be provided the virtio-comment mailing list, and archived in the mailing list archives. -- cgit