OpenFPGA/README.md

# Getting Started with OpenFPGA

[![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

OpenFPGA is an extension to VPR. It is an IP Verilog Generator allowing reliable and fast testing of homogeneous architectures.

## Compilation

The different ways of compiling can be found in the **./compilation** folder.<br />
Dependancies and help using docker can be found at [**./tutorials/building.md**](https://github.com/LNIS-Projects/OpenFPGA/blob/documentation/tutorials/building.md).

**Compilation steps:**
1. Clone the repository (git clone https://github.com/LNIS-Projects/OpenFPGA.git && cd OpenFPGA)
2. Create a folder named build in OpenPFGA repository (mkdir build && cd build)
3. Create Makefile in this folder using cmake (cmake ..  -DCMAKE_BUILD_TYPE=debug)
4. Compile the tool and its dependencies (make)

*We currently implemented OpenFPGA for:*

*1. Ubuntu 18.04*
*2. Red Hat 7.5*
*3. MacOS High Sierra 10.13.4*

*Please note that those were the versions we tested the software for. It might work with earlier versions and other distributions.*

## Documentation
OpenFPGA's [full documentation](https://openfpga.readthedocs.io/en/master/) includes tutorials, descriptions of the design flow, and tool options.

## Tutorial

You can find in the folder **./tutorials**. This will help you get in touch with the software and test different configurations to see how OpenFPGA reacts to them. 

Through this tutorial users can learn how to use the flow and set the dependancies.
Update Readme 2019-07-05 12:06:55 -05:00			`# Getting Started with OpenFPGA`
creating documentation 2018-09-13 12:52:12 -05:00
Update README.md 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)`

Update of the Readme and added an example ReadMe is now cleaner 2018-10-03 18:10:29 -05:00			`## Introduction`
creating documentation 2018-09-13 12:52:12 -05:00
Update Readme 2019-07-05 12:06:55 -05:00			`OpenFPGA is an extension to VPR. It is an IP Verilog Generator allowing reliable and fast testing of homogeneous architectures.`
creating documentation 2018-09-13 12:52:12 -05:00
Update of the Readme and added an example ReadMe is now cleaner 2018-10-03 18:10:29 -05:00			`## Compilation`
creating documentation 2018-09-13 12:52:12 -05:00
Update tutorial, readme and docker 2019-07-09 15:28:14 -05:00			`The different ways of compiling can be found in the ./compilation folder.<br />`
Tuto flow v2 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).`
creating documentation 2018-09-13 12:52:12 -05:00
Update Readme 2019-07-05 12:06:55 -05:00			`Compilation steps:`
Update docker part in building.md 2019-07-11 11:13:55 -05:00			`1. Clone the repository (git clone https://github.com/LNIS-Projects/OpenFPGA.git && cd OpenFPGA)`
			`2. Create a folder named build in OpenPFGA repository (mkdir build && cd build)`
			`3. Create Makefile in this folder using cmake (cmake .. -DCMAKE_BUILD_TYPE=debug)`
			`4. Compile the tool and its dependencies (make)`
creating documentation 2018-09-13 12:52:12 -05:00
Update Readme 2019-07-05 12:06:55 -05:00			`We currently implemented OpenFPGA for:`
creating documentation 2018-09-13 12:52:12 -05:00
Update Readme 2019-07-05 12:06:55 -05:00			`1. Ubuntu 18.04`
			`2. Red Hat 7.5`
			`3. MacOS High Sierra 10.13.4`

			`Please note that those were the versions we tested the software for. It might work with earlier versions and other distributions.`
ReadMe modifications to add the beginning of the FPGA-SPICE tutorial Modifications on the addresses aswell and the different commands when they were not working. To do still: -create a script to change the addresses when needed -continue the tutorial 2018-09-27 10:33:39 -05:00
Update README.md 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.`

Modify readme 2019-07-09 12:58:39 -05:00			`## Tutorial`
creating documentation 2018-09-13 12:52:12 -05:00
Modify readme 2019-07-09 12:58:39 -05:00			`You can find in the folder ./tutorials. This will help you get in touch with the software and test different configurations to see how OpenFPGA reacts to them.`
ReadMe modifications to add the beginning of the FPGA-SPICE tutorial Modifications on the addresses aswell and the different commands when they were not working. To do still: -create a script to change the addresses when needed -continue the tutorial 2018-09-27 10:33:39 -05:00
Modify readme 2019-07-09 12:58:39 -05:00			`Through this tutorial users can learn how to use the flow and set the dependancies.`
ReadMe modifications to add the beginning of the FPGA-SPICE tutorial Modifications on the addresses aswell and the different commands when they were not working. To do still: -create a script to change the addresses when needed -continue the tutorial 2018-09-27 10:33:39 -05:00

creating documentation 2018-09-13 12:52:12 -05:00