aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiodrag Milanovic <mmicko@gmail.com>2018-06-24 19:43:21 +0200
committerMiodrag Milanovic <mmicko@gmail.com>2018-06-24 19:43:21 +0200
commit8fcb06fa0e154e8d015e4726511d55d2d3857f2b (patch)
tree8e536a3b61ab60347496d83a6e21591adf577dec
parentacda434c6eaca0144480fd01a9ee2d3c6718cde9 (diff)
downloadnextpnr-8fcb06fa0e154e8d015e4726511d55d2d3857f2b.tar.gz
nextpnr-8fcb06fa0e154e8d015e4726511d55d2d3857f2b.tar.bz2
nextpnr-8fcb06fa0e154e8d015e4726511d55d2d3857f2b.zip
Added documentation for new commandline options for building
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index 751a864b..e0006b82 100644
--- a/README.md
+++ b/README.md
@@ -28,10 +28,23 @@ Building
- Use Make to run the build itself
- For all binary targets, just run `make`
- For just the iCE40 CLI&GUI binary, run `make nextpnr-ice40`
+ - To build binary without Python support, run `cmake -DBUILD_PYTHON=OFF .`
+ - To build binary without GUI, run `cmake -DBUILD_GUI=OFF .`
+ - For minimal binary without Python and GUI, run `cmake -DBUILD_PYTHON=OFF -DBUILD_GUI=OFF .`
- For just the iCE40 Python module, run `make nextpnrpy_ice40`
- Using too many parallel jobs may lead to out-of-memory issues due to the significant memory needed to build the chipdbs
- To install nextpnr, run `make install`
+Testing
+-------
+
+ - To build test binaries as well, run `cmake -DBUILD_TESTS=OFF .` and after run `make tests` to run them, or you can run separate binaries.
+ - To use code sanitizers use:
+ - cmake . -DSANITIZE_ADDRESS=ON
+ - cmake . -DSANITIZE_MEMORY=ON -DCMAKE_C_COMPILER=clang
+ - cmake . -DSANITIZE_THREAD=ON
+ - cmake . -DSANITIZE_UNDEFINED=ON
+
Running
--------