Added building instruction to README.md.
PATCH v2 1/1 Added building instruction to README.md.
--- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+)
README.md +34 -0
@@ -29,6 +29,40 @@ <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>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>. +Using +<code> +./makehtml.sh +</code> +should be enought if you just want to test your changes since +<code> +makepdf.sh +</code> +may required some font packages.</p> <h4>Providing Feedback</h4> Feedback must be provided the <strong>virtio-comment</strong> mailing list, and archived in the mailing list archives.
Signature · 21 lines
V1 -> V2:
* Added building instructions
2.21.0
This publicly archived list offers a means to provide input to the
OASIS Virtual I/O Device (VIRTIO) TC.
In order to verify user consent to the Feedback License terms and
to minimize spam in the list archive, subscription is required
before posting.
Subscribe: [email protected]
Unsubscribe: [email protected]
List help: [email protected]
List archive: https://lists.oasis-open.org/archives/virtio-comment/
Feedback License: https://www.oasis-open.org/who/ipr/feedback_license.pdf
List Guidelines: https://www.oasis-open.org/policies-guidelines/mailing-lists
Committee: https://www.oasis-open.org/committees/virtio/
Join OASIS: https://www.oasis-open.org/join/Quoted 37 lines · Yoni Bettan
Signed-off-by Yoni Bettan <[email protected]>--- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+)README.md +24
-0@@ -29,6 +29,40 @@ <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>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
README.md line 65
Quoted 10 lines
README.md +10
-0+</code>. +Using +<code> +./makehtml.sh +</code> +should be enought if you just want to test your changes since +<code> +makepdf.sh +</code> +may required some font packages.</p>
Thanks for adding instructions. I have hit latex errors in the past that only happened with makepdf.sh, so ideally everyone should use makeall.sh.
The font requirement is a real pain. Can we switch to widely available free fonts?
Stefan
Quoted 43 lines · Stefan Hajnoczi
Quoted 42 lines · Yoni Bettan
Signed-off-by Yoni Bettan <[email protected]>--- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+)README.md +29
-0@@ -29,6 +29,40 @@ <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>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>. +Using +<code> +./makehtml.sh +</code>
Quoted 8 lines
README.md line 65
Quoted 5 lines
README.md +5
-0+should be enought if you just want to test your changes since +<code> +makepdf.sh +</code> +may required some font packages.</p>Thanks for adding instructions. I have hit latex errors in the past that only happened with
makepdf.sh, so ideally everyone should usemakeall.sh.
Did you mean ideally everyone should use makehtml.sh ?
Quoted 5 lines
The font requirement is a real pain. Can we switch to widely available free fonts?
Stefan
Quoted 54 lines · Yoni Bettan
Quoted 42 lines · Stefan Hajnoczi
Quoted 41 lines · Yoni Bettan
Signed-off-by Yoni Bettan <[email protected]>--- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+)README.md +29
-0@@ -29,6 +29,40 @@ <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>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>. +Using +<code> +./makehtml.sh +</code>Quoted 8 lines
README.md line 65
Quoted 5 lines
README.md +5
-0+should be enought if you just want to test your changes since +<code> +makepdf.sh +</code> +may required some font packages.</p>Thanks for adding instructions. I have hit latex errors in the past that only happened with
makepdf.sh, so ideally everyone should usemakeall.sh.
Quoted 1 line
Did you mean ideally everyone should use
makehtml.sh?
No. You may miss errors if you only run one of makehtml.sh or makepdf.sh. You need to run makeall.sh to get full coverage.
Stefan