summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJohann Glaser <Johann.Glaser@gmx.at>2013-03-18 19:26:35 +0100
committerJohann Glaser <Johann.Glaser@gmx.at>2013-03-18 19:26:35 +0100
commit2192873daa7915aa034e9afd1fe82efbc61320d1 (patch)
tree5af7b0b23c0c5a71d8e230eca84a4c1b79adf5c3 /README
parent71de6660036c7cea95884554382bc2913af36252 (diff)
added description of Makefile include files for build configuration
Diffstat (limited to 'README')
-rw-r--r--README23
1 files changed, 17 insertions, 6 deletions
diff --git a/README b/README
index cbd77bb1..5da18947 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