Added notes for compilation on OS X
authorSteffen Vogel <post@steffenvogel.de>
Tue, 7 Feb 2017 14:12:31 +0000 (11:12 -0300)
committerSteffen Vogel <post@steffenvogel.de>
Tue, 7 Feb 2017 14:16:56 +0000 (11:16 -0300)
README.md

index 9b9f72cc07e8601e27a6787e9dc2eb53dbe68a82..f56bbf8cdb1bd5bb199842c8ddfc79c062d6bf86 100644 (file)
--- a/README.md
+++ b/README.md
@@ -40,14 +40,14 @@ Web Site
 More information and documentation can be found on the Yosys web site:
 http://www.clifford.at/yosys/
 
-
-Getting Started
-===============
+Setup
+======
 
 You need a C++ compiler with C++11 support (up-to-date CLANG or GCC is
 recommended) and some standard tools such as GNU Flex, GNU Bison, and GNU Make.
 TCL, readline and libffi are optional (see ENABLE_* settings in Makefile).
 Xdot (graphviz) is used by the ``show`` command in yosys to display schematics.
+
 For example on Ubuntu Linux 16.04 LTS the following commands will install all
 prerequisites for building yosys:
 
@@ -55,6 +55,13 @@ prerequisites for building yosys:
                libreadline-dev gawk tcl-dev libffi-dev git mercurial \
                graphviz xdot pkg-config python3
 
+Similarily, on Mac OS X MacPorts or Homebrew can be used to install dependencies:
+
+       $ brew install bison flex gawk libffi \
+               git mercurial graphviz pkg-config python3
+       $ sudo port install bison flex readline gawk libffi \ 
+               git mercurial graphviz pkg-config python3
+
 There are also pre-compiled Yosys binary packages for Ubuntu and Win32 as well
 as a source distribution for Visual Studio. Visit the Yosys download page for
 more information: http://www.clifford.at/yosys/download.html
@@ -80,6 +87,9 @@ To build Yosys simply type 'make' in this directory.
 Note that this also downloads, builds and installs ABC (using yosys-abc
 as executable name).
 
+Getting Started
+===============
+
 Yosys can be used with the interactive command shell, with
 synthesis scripts or with command line arguments. Let's perform
 a simple synthesis job using the interactive command shell: