README: explain how to do out-of-tree builds.
authorwhitequark <whitequark@whitequark.org>
Fri, 24 Apr 2020 18:07:13 +0000 (18:07 +0000)
committerwhitequark <whitequark@whitequark.org>
Fri, 24 Apr 2020 23:27:43 +0000 (23:27 +0000)
README.md

index 0a81d8bb957898b2c5c0496c53277f2f4ab8778f..1e486c3ac7a1918556b6339fa9f33332f1e254f6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -118,6 +118,13 @@ Tests are located in the tests subdirectory and can be executed using the test t
 
        $ make test
 
+To use a separate (out-of-tree) build directory, provide a path to the Makefile.
+
+       $ mkdir build; cd build
+       $ make -f ../Makefile
+
+Out-of-tree builds require a clean source tree.
+
 Getting Started
 ===============
 
@@ -388,7 +395,7 @@ Verilog Attributes and non-standard features
 
 - The cell attribute ``wildcard_port_conns`` represents wildcard port
   connections (SystemVerilog ``.*``). These are resolved to concrete
-  connections to matching wires in ``hierarchy``.  
+  connections to matching wires in ``hierarchy``.
 
 - In addition to the ``(* ... *)`` attribute syntax, Yosys supports
   the non-standard ``{* ... *}`` attribute syntax to set default attributes