aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorClifford Wolf <clifford@clifford.at>2013-03-19 13:47:46 +0100
committerClifford Wolf <clifford@clifford.at>2013-03-19 13:47:46 +0100
commit0d39366e2ce9f7a23d47ae1191371ff305a08eb0 (patch)
tree0093dadd88b796f71361599402bccbfc4c8024de /README
parent71de6660036c7cea95884554382bc2913af36252 (diff)
parent9f10acb84042ce0943c3b4d1234efa3899f0dff1 (diff)
downloadyosys-0d39366e2ce9f7a23d47ae1191371ff305a08eb0.tar.gz
yosys-0d39366e2ce9f7a23d47ae1191371ff305a08eb0.tar.bz2
yosys-0d39366e2ce9f7a23d47ae1191371ff305a08eb0.zip
Merge branch 'hansiglaser-master'
Diffstat (limited to 'README')
-rw-r--r--README25
1 files changed, 19 insertions, 6 deletions
diff --git a/README b/README
index cbd77bb17..97f2ba9b1 100644
--- a/README
+++ b/README
@@ -40,14 +40,25 @@ or the 2-clause BSD license).
Getting Started
===============
-To build Yosys simply type 'make' in this directory. 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. It might be necessary to make some changes to
-the config section of the Makefile. The extensive tests require
-Icarus Verilog.
+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. The extensive tests require Icarus Verilog.
+
+To configure the build system to use a specific set of compiler and
+build configuration, use one of
+
+ $ make config-clang-debug
+ $ make config-gcc-debug
+ $ make config-release
+
+For other compilers and build configurations it might be
+necessary to make some changes to the config section of the
+Makefile.
$ vi Makefile
+
+To build Yosys simply type 'make' in this directory.
+
$ make
$ make test
$ sudo make install
@@ -237,3 +248,5 @@ TODOs / Open Bugs
- Better FSM state encoding
+- For pass' "fsm_detect" help: add notes what criteria lets it detect an FSM
+