Skip to contentSkip to conversation

Added building instructions to README.md

PATCH In review Yoni Bettan 2 participants 4 messages Aug 20, 2019 – Aug 27, 2019

lore
Share & tools
lore
#0 lore raw

v4 cover Added building instructions to README.md

V3 -> V4:

- Changed the fonts to liberation fonts only if 'Arial' and 'Courier New' fonts are not available otherwise stick with the original fonts.

V2 -> V3:

- Changed the fonts to liberation fonts
- Added building instruction for OSX user

V1 -> V2:

- Added building instructions to README.md

Yoni Bettan (2):
Changed fonts to freely-available fonts when built locally. README.md: Added building instructions.

 README.md        | 28 ++++++++++++++++++++++++++++
 commands-pdf.tex | 12 ++++++------
 virtio.tex       |  4 ++--
 3 files changed, 36 insertions(+), 8 deletions(-)
Signature · 18 lines
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/
#1 lore raw

PATCH v4 1/2 Changed fonts to freely-available fonts when built locally.

'Arial' and 'Courier New' fonts are not installed in TeX Live by default therefore when building the spec document using 'makeall.sh' on a Linux machine, that usually have Tex Live installed, we get fonts error for those fonts.

This patch is checking if those fonts exist on the machine inside the tex document and if not change them to freely-available fonts:

    Arial -> Liberation Sans
    Courier New -> Liberation Mono
---
 commands-pdf.tex | 12 ++++++------
 virtio.tex       |  4 ++--
 2 files changed, 8 insertions(+), 8 deletions(-)
commands-pdf.tex +6 -6
index ae7a186..23289d8 100644
@@ -20,7 +20,7 @@
 \newcommand{\oasistitle}[1]
 {
 \begin{spacing}{1.5}
-\fontspec[Color=446CAA]{Arial}
+\IfFontExistsTF{Arial}{\fontspec[Color=446CAA]{Arial}}{\fontspec[Color=446CAA]{Liberation Sans}}
 \fontsize{24}{24}
 \textbf{\noindent#1}
 \end{spacing}
@@ -29,7 +29,7 @@
 \newcommand{\oasisstagelabel}[1]
 {
 \begin{spacing}{1.1}
-\fontspec[Color=446CAA]{Arial}
+\IfFontExistsTF{Arial}{\fontspec[Color=446CAA]{Arial}}{\fontspec[Color=446CAA]{Liberation Sans}}
 \fontsize{18}{18}
 \textbf{\noindent#1}
 \end{spacing}
@@ -38,7 +38,7 @@
 \newcommand{\oasisdate}[1]
 {
 \begin{spacing}{1.1}
-\fontspec[Color=446CAA]{Arial}
+\IfFontExistsTF{Arial}{\fontspec[Color=446CAA]{Arial}}{\fontspec[Color=446CAA]{Liberation Sans}}
 \fontsize{18}{18}
 \textbf{\noindent#1}
 \end{spacing}
@@ -47,7 +47,7 @@
 \newcommand{\oasisnoticelabel}[1]
 {
 \begin{spacing}{1.5}
-\fontspec[Color=446CAA]{Arial}
+\IfFontExistsTF{Arial}{\fontspec[Color=446CAA]{Arial}}{\fontspec[Color=446CAA]{Liberation Sans}}
 \fontsize{18}{18}
 \textbf{\noindent#1}
 \end{spacing}
@@ -56,7 +56,7 @@
 \newcommand{\oasisspecificationuris}[1]
 {
 {
-\fontspec[Color=446CAA]{Arial}
+\IfFontExistsTF{Arial}{\fontspec[Color=446CAA]{Arial}}{\fontspec[Color=446CAA]{Liberation Sans}}
 \fontsize{12}{12}
 \textbf{\noindent#1}
 }
@@ -65,7 +65,7 @@
 \newenvironment{oasistitlesection}[1]
 {
 \setlength{\tabcolsep}{0in}\begin{tabular}{p{0in}p{5.8in}}
-\multicolumn{2}{l}{\fontspec[Color=446CAA]{Arial}\fontsize{10}{10}\textbf{#1:}}\\[-0.05in]
+\multicolumn{2}{l}{\IfFontExistsTF{Arial}{\fontspec[Color=446CAA]{Arial}}{\fontspec[Color=446CAA]{Liberation Sans}}\fontsize{10}{10}\textbf{#1:}}\\[-0.05in]
 &\setlength{\topsep}{0in}\setlength{\parsep}{0in}\setlength{\partopsep}{0in}   }
 {
 \end{tabular}
virtio.tex +2 -2
index ef2d3fe..a99bb3f 100644
@@ -52,9 +52,9 @@
 %\def_{\_}
 % Don't hyphenate acronyms
 %\uchyph=0
-\setmainfont[Mapping=tex-text]{Arial}
+\IfFontExistsTF{Arial}{\setmainfont[Mapping=tex-text]{Arial}}{\setmainfont[Mapping=tex-text]{Liberation Sans}}
 %\setromanfont{Arial}
-\setmonofont{Courier New}
+\IfFontExistsTF{Courier New}{\setmonofont{Courier New}}{\setmonofont{Liberation Mono}}
 
 \urlstyle{rm}
 
Signature · 18 lines
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/
#2 lore raw

PATCH v4 2/2 README.md: Added building instructions.

In reply to Yoni Bettan
---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
README.md +28 -0
index 4747824..5ac84f9 100644
@@ -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.
Signature · 18 lines
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/
Reviewed-by on the v4 series
#3 lore raw
In reply to Yoni Bettan
Quoted 10 lines · Yoni Bettan

V3 -> V4:

- Changed the fonts to liberation fonts only if 'Arial' and 'Courier New' fonts are not available otherwise stick with the original fonts.

V2 -> V3:

- Changed the fonts to liberation fonts
- Added building instruction for OSX user

Quoted 7 lines

V1 -> V2:

- Added building instructions to README.md

Yoni Bettan (2):
Changed fonts to freely-available fonts when built locally. README.md: Added building instructions.

Series:

Signature · 17 lines
Eduardo

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/