- 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@xxxxxxxxxx> --- 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@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
