aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/README
diff options
context:
space:
mode:
authorbryan newbold <bnewbold@leaflabs.com>2013-11-13 11:45:45 -0500
committerbryan newbold <bnewbold@leaflabs.com>2013-11-13 11:45:45 -0500
commit171eeca840ee34f4210471192845c1f21cad7c31 (patch)
treed7847e9f02c065103d958164b7d297f5dd1c5a09 /contrib/README
parent0451d1c0df95884d39b85f26a736df1f3086e642 (diff)
downloadbasic-hdl-template-171eeca840ee34f4210471192845c1f21cad7c31.tar.gz
basic-hdl-template-171eeca840ee34f4210471192845c1f21cad7c31.zip
docs in contrib/README
Diffstat (limited to 'contrib/README')
-rw-r--r--contrib/README14
1 files changed, 14 insertions, 0 deletions
diff --git a/contrib/README b/contrib/README
index 55508f8..5885aa9 100644
--- a/contrib/README
+++ b/contrib/README
@@ -1,4 +1,18 @@
+### Notes
+
+By default, re-synthesis of a project (eg, after making a change to any HDL
+files) will attempt to use the previous place-and-route netlist as a starting
+point via the "smartguide" mechanism. 'make mostlyclean' will prevent this.
+
+Changes to Makefiles will *not* necessarily result in a full rebuild; the
+makefiles themselves are not a prerequisite of any targets. It is *strongly*
+recommended that you 'make clean' (not just 'mostlyclean') after any
+significant modifications to project settings, particularly changes to the
+target part number.
+
+### Make Targets
+
make bitfiles - synths bitfiles and copies to ./bitfiles/ (DEFAULT)
make synth - compiles and synthesizes bitfiles (no copying)
make tests - runs all unittests