nextpnr/README.md

37 lines
1.3 KiB
Markdown
Raw Normal View History

2018-06-02 19:23:50 +08:00
nextpnr -- a portable FPGA place and route tool
===============================================
Supported Architectures
-----------------------
- iCE40
Prequisites
-----------
- CMake 3.3 or later
- Modern C++11 compiler, clang recommended
- Qt5 or later (`qt5-default` for Ubuntu 16.04)
- Python 3.5 or later, including development libraries (`python3-dev` for Ubuntu)
- Boost libraries (`libboost-dev` or `libboost-all-dev` for Ubuntu)
- Icestorm, with chipdbs installed in `/usr/local/share/icebox`
2018-06-02 19:23:50 +08:00
Building
--------
- 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 debug build with HX1K support only, run ` cmake -DCMAKE_BUILD_TYPE=Debug -DICE40_HX1K_ONLY=1 .`
- 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`