From: whitequark <whitequark@whitequark.org>
Date: Fri, 24 Apr 2020 18:07:13 +0000 (+0000)
Subject: README: explain how to do out-of-tree builds.
X-Git-Tag: working-ls180~579^2
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=9b26a1fa89e34af8651af381d88088b738c75769;p=yosys.git

README: explain how to do out-of-tree builds.
---

diff --git a/README.md b/README.md
index 0a81d8bb9..1e486c3ac 100644
--- 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