OpenFPGA/README.md

39 lines
2.3 KiB
Markdown
Raw Normal View History

2019-07-05 12:06:55 -05:00
# Getting Started with OpenFPGA
2018-09-13 12:52:12 -05:00
2018-12-30 15:35:07 -06:00
[![Build Status](https://travis-ci.org/LNIS-Projects/OpenFPGA.svg?branch=master)](https://travis-ci.org/LNIS-Projects/OpenFPGA)
[![Documentation Status](https://readthedocs.org/projects/openfpga/badge/?version=master)](https://openfpga.readthedocs.io/en/master/?badge=master)
## Introduction
2018-09-13 12:52:12 -05:00
2019-07-12 15:56:08 -05:00
The OpenFPGA framework is the **first open-source FPGA IP generator** supporting highly-customizable homogeneous FPGA architectures. OpenFPGA provides a full set of EDA support for customized FPGAs, including Verilog-to-bitstream generation and self-testing verification testbenches/scripts. OpenFPGA opens the door to democratizing FPGA technology and EDA techniques, with agile prototyping approaches and constantly evolving EDA tools for chip designers and researchers.<br />
2018-09-13 12:52:12 -05:00
## Compilation
2018-09-13 12:52:12 -05:00
2019-07-12 15:56:08 -05:00
The different ways of compiling can be found in the [**./compilation**](https://github.com/LNIS-Projects/OpenFPGA/tree/documentation/compilation) folder.<br />
2019-07-10 17:00:22 -05:00
Dependancies and help using docker can be found at [**./tutorials/building.md**](https://github.com/LNIS-Projects/OpenFPGA/blob/documentation/tutorials/building.md).
2018-09-13 12:52:12 -05:00
2019-07-05 12:06:55 -05:00
**Compilation steps:**
2019-07-15 22:16:15 -05:00
1. git clone https://github.com/LNIS-Projects/OpenFPGA.git && cd OpenFPGA # *Clone the repository and go into it*
2. mkdir build && cd build # *Create a folder named build in OpenPFGA repository*
3. cmake .. -DCMAKE_BUILD_TYPE=debug # *Create Makefile in this folder using cmake*
4. make # *Compile the tool and its dependencies*
*We currently implemented OpenFPGA for:*<br />
*1. Ubuntu 16.04*<br />
*2. Red Hat 7.5*<br />
*3. MacOS Mojiva 10.13.4*<br /><br />
2019-07-05 12:06:55 -05:00
*Please note that those were the versions we tested the software for. It might work with earlier versions and other distributions.*
2018-12-30 15:37:17 -06:00
## Documentation
OpenFPGA's [full documentation](https://openfpga.readthedocs.io/en/master/) includes tutorials, descriptions of the design flow, and tool options.
2019-07-09 12:58:39 -05:00
## Tutorial
2018-09-13 12:52:12 -05:00
2019-07-12 15:56:08 -05:00
You can find in the folder [**./tutorials**](https://github.com/LNIS-Projects/OpenFPGA/tree/documentation/tutorials). This will help you get in touch with the software and test different configurations to see how OpenFPGA reacts to them.
2019-07-12 15:56:08 -05:00
Through this tutorial users can learn how to use the flow and set the dependancies.<br />
The [tutorial index](https://github.com/LNIS-Projects/OpenFPGA/blob/documentation/tutorials/tutorial_index.md) will
2018-09-13 12:52:12 -05:00