From 763fd56c2639c53f109245f8b029f24362d60d33 Mon Sep 17 00:00:00 2001 From: David Shah Date: Sat, 2 Jun 2018 13:57:08 +0200 Subject: [PATCH] Update README with CMake instructions Signed-off-by: David Shah --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 652be226..2cfe0679 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,29 @@ Supported Architectures - iCE40 +Prequisites +----------- + + - CMake 3.3 or later + - Modern C++11 compiler, clang recommended + - Python 3.5 or later, including development libraries (`python3-dev` for Ubuntu) + - Boost libraries (`libboost-all-dev` for Ubuntu) + - Icestorm, with chipdbs installed in `/usr/local/share/icebox` + Building -------- -Simply run `make`. \ No newline at end of file + - Use CMake to generate the Makefiles (only needs to be done when `CMakeLists.txt` changes) + - For a debug build, run `cmake -DCMAKE_BUILD_TYPE=Debug .` + - For a release build, run `cmake .` + - Use Make to run the build itself + - For all targets, just run `make` + - For just the iCE40 CLI binary, run `make nextpnr-ice40` + - 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 + +Running +-------- + + - To run the CLI binary, just run `./nextpnr-ice40` + - The Python module is called `nextpnrpy_ice40.so`. To test it, run `PYTHONPATH=. python3 python/python_test.py`