added description of Makefile include files for build configuration
authorJohann Glaser <Johann.Glaser@gmx.at>
Mon, 18 Mar 2013 18:26:35 +0000 (19:26 +0100)
committerJohann Glaser <Johann.Glaser@gmx.at>
Mon, 18 Mar 2013 18:26:35 +0000 (19:26 +0100)
README

diff --git a/README b/README
index cbd77bb177563c19cd9946d3b64bd5ea73f6e1f8..5da189473c0d71b7b14e8ada8f1886b9bf2c2bd7 100644 (file)
--- 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