aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorSteffen Vogel <post@steffenvogel.de>2017-02-07 11:12:31 -0300
committerSteffen Vogel <post@steffenvogel.de>2017-02-07 11:16:56 -0300
commitb8d531957d4ff77afa10f12a7909f763aa367230 (patch)
tree2f809aeda3009655ae42fb64ee4030ae608dfa1b /README.md
parent7e08e37961a061807cec7aa335edbbab47891ce9 (diff)
downloadyosys-b8d531957d4ff77afa10f12a7909f763aa367230.tar.gz
yosys-b8d531957d4ff77afa10f12a7909f763aa367230.tar.bz2
yosys-b8d531957d4ff77afa10f12a7909f763aa367230.zip
Added notes for compilation on OS X
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 13 insertions, 3 deletions
diff --git a/README.md b/README.md
index 9b9f72cc0..f56bbf8cd 100644
--- 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: