From patchwork Mon May 23 11:08:42 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Kanta Vekaria X-Patchwork-Id: 68371 Delivered-To: patch@linaro.org Received: by 10.140.92.199 with SMTP id b65csp18562qge; Mon, 23 May 2016 04:08:53 -0700 (PDT) X-Received: by 10.98.66.149 with SMTP id h21mr8705980pfd.56.1464001733148; Mon, 23 May 2016 04:08:53 -0700 (PDT) Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id p3si51196314pfp.130.2016.05.23.04.08.52; Mon, 23 May 2016 04:08:53 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of devicetree-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; dkim=neutral (body hash did not verify) header.i=@linaro.org; spf=pass (google.com: best guess record for domain of devicetree-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=devicetree-owner@vger.kernel.org; dmarc=fail (p=NONE dis=NONE) header.from=linaro.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752256AbcEWLIv (ORCPT + 7 others); Mon, 23 May 2016 07:08:51 -0400 Received: from mail-wm0-f47.google.com ([74.125.82.47]:37935 "EHLO mail-wm0-f47.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751400AbcEWLIv (ORCPT ); Mon, 23 May 2016 07:08:51 -0400 Received: by mail-wm0-f47.google.com with SMTP id n129so67284574wmn.1 for ; Mon, 23 May 2016 04:08:50 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id; bh=k/ve30oasV+u+q4HF3qjZ+/k3jcTNIK7P7gqN9N1zuI=; b=Gvcf9eJ10KKDb49GH6vZlG3zuDbxmg2KwG7AptCpGJlTipyHHY0IGXlQo5oPfDMB2B GmD3pRb0kDlnx9z97QgPh3c5Xbd9BHm9muYjZBjtA3kb+FPSstVxniMHWGPU875qd6/x uh028Pw+JUB71e8jUDUTn08QTjB8wgFpvqI4U= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=k/ve30oasV+u+q4HF3qjZ+/k3jcTNIK7P7gqN9N1zuI=; b=cZU8WFQXqkWxzBJ4Vt+YFaOd122LGsEHGvU83XSA/WzSkaRkimpBn1BeERYET3M9lr JQfsDvnGMWKs4vz2E/CQb0sf1shdBgfX68SZPTAzRuI29GXg8jp3k08p+lneo2KgB/40 3PXg8xEh5uzaSBssnMGypSkzWndYX+OBqpefzPu73KJTv92Hkqj0KqCrpG5+prIJG+Gn dmHTZ60Lv1155v5KtwtbBP9v9KU64wB0ImAJR4pYYgwpK+pmSN8LY22jDAW3g+j+RdwN CFhyQOfYSXZt3cTsa3DkvPgkTW5+WyYL8ZUTsyKIY/MAvVmjMm9yWbqND+NlRVIQ19d6 A3Sg== X-Gm-Message-State: ALyK8tKsHLAAch71wgu/2yU0N/4hjU4WYR5pWTK5G/DxYO0RmMDBxkxwhe5IIWNoLPNUcZua X-Received: by 10.28.163.69 with SMTP id m66mr1246651wme.101.1464001729734; Mon, 23 May 2016 04:08:49 -0700 (PDT) Received: from localhost.localdomain (cpc82863-enfi22-2-0-cust131.20-2.cable.virginm.net. [77.98.140.132]) by smtp.gmail.com with ESMTPSA id f135sm13149938wmf.22.2016.05.23.04.08.48 (version=TLS1 cipher=AES128-SHA bits=128/128); Mon, 23 May 2016 04:08:49 -0700 (PDT) From: Kanta Vekaria To: devicetree@vger.kernel.org Cc: Charles.Garcia-Tobin@arm.com, grant.likely@secretlab.ca, kanta.vekaria@linaro.org Subject: [PATCH] Add build instructions for Mac OS X Date: Mon, 23 May 2016 12:08:42 +0100 Message-Id: <1464001722-12840-1-git-send-email-kanta.vekaria@linaro.org> X-Mailer: git-send-email 2.7.4 (Apple Git-66) Sender: devicetree-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: devicetree@vger.kernel.org - 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 --- README.md | 68 +++++++++++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 47 insertions(+), 21 deletions(-) -- 2.7.4 (Apple Git-66) -- To unsubscribe from this list: send the line "unsubscribe devicetree" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html 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.