OpenFPGA/tutorials/building.md

55 lines
1.4 KiB
Markdown
Raw Normal View History

2019-07-09 15:28:14 -05:00
# How to build?
2019-07-16 15:58:11 -05:00
## Dependencies
OpenFPGA requires all the following dependencies:
2019-07-09 15:28:14 -05:00
- autoconf
- automake
- bash
- bison
- build-essential
- cmake (version 3.X at least)
- ctags
- curl
- doxygen
- flex
- fontconfig
- g++-8
- gcc-8
- g++-4.9
- gcc-4.9
- gdb
- git
- gperf
- iverilog
- libcairo2-dev
- libevent-dev
- libfontconfig1-dev
- liblist-moreutils-perl
- libncurses5-dev
- libx11-dev
- libxft-dev
- libxml++2.6-dev
- perl
- python
- texinfo
- time
- valgrind
- zip
- qt5-default
## Docker
2019-07-17 13:09:59 -05:00
If some of these dependencies are not installed on your machine, you can choose to use a Docker (the Docker tool needs to be installed). For the ease of the customer first experience, a Dockerfile is provided in the OpenFPGA folder. A container ready to use can be created with the following command:
2019-07-16 12:52:24 -05:00
- docker run lnis/open_fpga:release <br />
2019-07-17 13:09:59 -05:00
*Warning: This command is for quick testing. If you want to conserve your work, you should certainly use other options, such as "-v".*
2019-07-12 15:56:08 -05:00
2019-07-16 15:58:11 -05:00
Otherwise, a container where you can build OpenFPGA yourself can be created with the following commands:
2019-07-09 15:28:14 -05:00
- docker build . -t open_fpga
2019-07-11 11:10:30 -05:00
- docker run -it --rm -v $PWD:/localfile/OpenFPGA -w="/localfile/OpenFPGA" open_fpga bash<br />
2019-07-10 17:14:38 -05:00
[*docker download link*](https://www.docker.com/products/docker-desktop)
2019-07-09 15:28:14 -05:00
## Building
2019-07-17 13:09:59 -05:00
To build the tool, go in the OpenFPGA folder and do:
2019-07-09 15:28:14 -05:00
- mkdir build && cd build
2019-07-10 16:42:31 -05:00
- cmake .. -DCMAKE_BUILD_TYPE=debug
2019-07-11 11:13:55 -05:00
- make (*WARNING using docker you cannot use "make -j", errors will happen*)