diff options
| author | David Shah <davey1576@gmail.com> | 2018-06-08 11:24:32 +0200 |
|---|---|---|
| committer | David Shah <davey1576@gmail.com> | 2018-06-08 11:24:32 +0200 |
| commit | 5fa79cd2b586d9bb0c872360ff30434f8fcfa5ba (patch) | |
| tree | fa03a2cbc5964991bf23b7ef1bb0efebc1299a90 /README.md | |
| parent | c16a971c0fe5980a2d6da23e7d3d6d917cb9dc67 (diff) | |
| download | nextpnr-5fa79cd2b586d9bb0c872360ff30434f8fcfa5ba.tar.gz nextpnr-5fa79cd2b586d9bb0c872360ff30434f8fcfa5ba.tar.bz2 nextpnr-5fa79cd2b586d9bb0c872360ff30434f8fcfa5ba.zip | |
Updating README.md
Signed-off-by: David Shah <davey1576@gmail.com>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 15 |
1 files changed, 12 insertions, 3 deletions
@@ -10,11 +10,12 @@ Prequisites ----------- - CMake 3.3 or later - - Modern C++11 compiler, clang recommended + - Modern C++11 compiler, clang recommended (`clang-format` required for development) - 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` + - Latest git Yosys is required to synthesise the demo design Building -------- @@ -32,5 +33,13 @@ Building 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` + - To run the CLI binary, just run `./nextpnr-ice40` (you should see command line help) + - To start the UI, run `./nextpnr-ice40 --gui` + - The Python module is called `nextpnrpy_ice40.so`. To test it, run `PYTHONPATH=. python3 python/python_mod_test.py` + +Notes +------- + + - All code is formatted using `clang-format` according to the style rules in `.clang-format` (LLVM based with + increased indent widths and brace wraps after classes). + - To automatically format all source code, run `make clangformat`. |