devicetree.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Kanta Vekaria <kanta.vekaria-QSEj5FYQhm4dnm+yROfE0A@public.gmane.org>
To: devicetree-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
Cc: Charles.Garcia-Tobin-5wv7dgnIgG8@public.gmane.org,
	grant.likely-s3s/WqlpOiPyB63q8FvJNQ@public.gmane.org,
	kanta.vekaria-QSEj5FYQhm4dnm+yROfE0A@public.gmane.org
Subject: [PATCH] Add build instructions for Mac OS X
Date: Mon, 23 May 2016 12:08:42 +0100	[thread overview]
Message-ID: <1464001722-12840-1-git-send-email-kanta.vekaria@linaro.org> (raw)

- Provides build instructions for Mac users
  who either use macports or brew
- Also provides commands to install Sphinx
- Update formatting to accomodate the above
  and tidy layout
- Fixed spelling to python-sphinx

Signed-off-by: Kanta Vekaria <kanta.vekaria-QSEj5FYQhm4dnm+yROfE0A@public.gmane.org>
---
 README.md | 68 +++++++++++++++++++++++++++++++++++++++++++--------------------
 1 file changed, 47 insertions(+), 21 deletions(-)

diff --git a/README.md b/README.md
index 60415c0..882abf9 100644
--- a/README.md
+++ b/README.md
@@ -18,27 +18,53 @@ Requirements:
 
 On Ubuntu:
 
-```
-# apt-get install python-sphinx latexdiff texlive texlive-latex-extra \
-                  texlive-humanities texlive-generic-recommended graphviz
-```
-
-If the version of python-spinx installed is too old, then an additional
-new version can be installed with the Python package installer:
-
-```
-$ apt-get install python-pip
-$ pip install --user --upgrade Sphinx
-$ export SPHINXBUILD=~/.local/bin/sphinx-build
-```
-
-Export SPHINXBUILD (see above) if Sphinx was installed with pip --user, then:
-
-```
-$ make latexpdf # For generating pdf
-$ make html # For generating a hierarchy of html pages
-$ make singlehtml # For generating a single html page
-```
+>```
+># apt-get install python-sphinx latexdiff texlive texlive-latex-extra \
+>                  texlive-humanities texlive-generic-recommended graphviz
+>```
+>
+>If the version of python-sphinx installed is too old, then an additional
+>new version can be installed with the Python package installer:
+>
+>```
+>$ apt-get install python-pip
+>$ pip install --user --upgrade Sphinx
+>$ export SPHINXBUILD=~/.local/bin/sphinx-build
+>```
+>
+>Export SPHINXBUILD (see above) if Sphinx was installed with pip --user, then follow Make commands below
+
+On Mac OS X:
+
+> Install [MacTeX](http://tug.org/mactex/)
+>
+> Install pip if you don't have it:
+>```
+>$ sudo easy_install pip
+>```
+>Install Sphinx
+>```
+>pip install --user --upgrade Sphinx
+>Or
+>sudo pip install --upgrade Sphinx
+>```
+>
+>If your are using [brew](http://brew.sh) then you can install graphviz like this:
+>```
+brew install graphviz
+>```
+>If you are using [macports](https://www.macports.org/) then you can install graphviz like this:
+>```
+>$ sudo port install graphviz
+>```
+
+Make commands:
+
+>```
+>$ make latexpdf # For generating pdf
+>$ make html # For generating a hierarchy of html pages
+>$ make singlehtml # For generating a single html page
+>```
 
 Output goes in ./build subdirectory.
 
-- 
2.7.4 (Apple Git-66)

--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

                 reply	other threads:[~2016-05-23 11:08 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1464001722-12840-1-git-send-email-kanta.vekaria@linaro.org \
    --to=kanta.vekaria-qsej5fyqhm4dnm+yrofe0a@public.gmane.org \
    --cc=Charles.Garcia-Tobin-5wv7dgnIgG8@public.gmane.org \
    --cc=devicetree-u79uwXL29TY76Z2rM5mHXA@public.gmane.org \
    --cc=grant.likely-s3s/WqlpOiPyB63q8FvJNQ@public.gmane.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).