aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorYoni Bettan <ybettan@redhat.com>2019-08-20 15:01:44 +0300
committerMichael S. Tsirkin <mst@redhat.com>2019-09-25 06:42:17 -0400
commit31f4e0e2a45b23090de6e37bc8a7ae240910bd1f (patch)
treed0d50b4fc95cf8907b7eb22278e6e6da24ba4369
parent1e155e48b34de307c0a932ff71186df166af5ece (diff)
downloadvirtio-spec-31f4e0e2a45b23090de6e37bc8a7ae240910bd1f.tar.gz
README.md: Added building instructions.
Signed-off-by: Yoni Bettan <ybettan@redhat.com> Signed-off-by: Michael S. Tsirkin <mst@redhat.com> Reviewed-by: Eduardo Habkost <ehabkost@redhat.com> Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
-rw-r--r--README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md
index 4747824..5ac84f9 100644
--- a/README.md
+++ b/README.md
@@ -29,6 +29,34 @@
<div>
<h3>Further Description of this Repository</h3>
+<h4>Building Instructions</h4>
+<p>In order to build the spec you will need <a href="https://www.tug.org/texlive/">Tex-Live</a>.
+Installing it can be done via:<br>
+Fedora:
+<code>
+sudo dnf install texlive-scheme-full
+</code><br>
+Ubuntu:
+<code>
+sudo apt-get install texlive-full
+</code><br></p>
+<p>OSX users don't need to install Tex-Live because they already have
+<a href="http://www.tug.org/mactex/">MacTex</a> installed.
+
+<p>The building proccess is done with
+<code>
+./makeall.sh
+</code>
+and it contains 3 main parts:
+<code>
+makezip.sh
+</code>,
+<code>
+makehtml.sh
+</code>,
+<code>
+makepdf.sh
+</code>.
<h4>Providing Feedback</h4>
Feedback must be provided the <strong>virtio-comment</strong> mailing list,
and archived in the mailing list archives.