Re: [virtio-comment] [PATCH V2] Added building instruction to README.md.

[Stefan Hajnoczi <stefanha@redhat.com>]

On Tue, Jun 25, 2019 at 11:29:28AM +0300, Yoni Bettan wrote:
> 
> On 6/25/19 10:52 AM, Stefan Hajnoczi wrote:
> > On Tue, Jun 25, 2019 at 10:33:36AM +0300, Yoni Bettan wrote:
> > > Signed-off-by: Yoni Bettan <ybettan@redhat.com>
> > > ---
> > >   README.md | 34 ++++++++++++++++++++++++++++++++++
> > >   1 file changed, 34 insertions(+)
> > > 
> > > diff --git a/README.md b/README.md
> > > index 3de0c1e..fc33c9f 100644
> > > --- a/README.md
> > > +++ b/README.md
> > > @@ -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>
> > 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.
> 
> 
> 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

Attachment: signature.asc
Description: PGP signature