Update Readme and tutorial

This commit is contained in:
AurelienUoU 2019-07-12 14:56:08 -06:00
parent e65cf9f5fd
commit d10cc34c9e
3 changed files with 11 additions and 7 deletions

View File

@ -3,6 +3,6 @@ FROM ubuntu:16.04
RUN apt-get update -qq -y RUN apt-get update -qq -y
RUN apt-get -y install python3 python3-dev tcl tcl8.6-dev gawk libreadline-dev RUN apt-get -y install python3 python3-dev tcl tcl8.6-dev gawk libreadline-dev
RUN apt-get -y install autoconf automake bison build-essential cmake ctags curl doxygen flex fontconfig g++-4.9 gcc-4.9 gdb git gperf iverilog libffi-dev libcairo2-dev libevent-dev libfontconfig1-dev liblist-moreutils-perl libncurses5-dev libx11-dev libxft-dev libxml++2.6-dev perl texinfo time valgrind zip qt5-default RUN apt-get -y install autoconf automake bison build-essential cmake ctags curl doxygen flex fontconfig g++-4.9 gcc-4.9 gdb git gtkwave gperf iverilog libffi-dev libcairo2-dev libevent-dev libfontconfig1-dev liblist-moreutils-perl libncurses5-dev libx11-dev libxft-dev libxml++2.6-dev perl texinfo time valgrind zip qt5-default

View File

@ -5,11 +5,11 @@
## Introduction ## Introduction
OpenFPGA is an extension to VPR. It is an IP Verilog Generator allowing reliable and fast testing of homogeneous architectures. 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 />
## Compilation ## Compilation
The different ways of compiling can be found in the **./compilation** folder.<br /> The different ways of compiling can be found in the [**./compilation**](https://github.com/LNIS-Projects/OpenFPGA/tree/documentation/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). 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:** **Compilation steps:**
@ -20,7 +20,7 @@ Dependancies and help using docker can be found at [**./tutorials/building.md**]
*We currently implemented OpenFPGA for:* *We currently implemented OpenFPGA for:*
*1. Ubuntu 18.04* *1. Ubuntu 16.04*
*2. Red Hat 7.5* *2. Red Hat 7.5*
*3. MacOS High Sierra 10.13.4* *3. MacOS High Sierra 10.13.4*
@ -31,9 +31,10 @@ OpenFPGA's [full documentation](https://openfpga.readthedocs.io/en/master/) incl
## Tutorial ## 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. 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.
Through this tutorial users can learn how to use the flow and set the dependancies. 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

View File

@ -40,7 +40,10 @@ OpenFPGA requires all the dependancies listed below:
## Docker ## Docker
If all these dependancies are not installed in your machine you can choose to use a Docker (docker tool need to be installed). To ease customer first experience a Dockerfile is provided in OpenFPGA folder. It can be build using the commands: If all these dependancies are not installed in your machine you can choose to use a Docker (docker tool need to be installed). To ease customer first experience a Dockerfile is provided in OpenFPGA folder. A container ready to use can be created with the following command:
- docker run -it --rm -v `pwd`:/localfile/OpenFPGA -w=“/localfile/OpenFPGAr” lnis-projects/open_fpga bash
Or a container where you can build OpenFPGA yourself can be created with the following commands:
- docker build . -t open_fpga - docker build . -t open_fpga
- docker run -it --rm -v $PWD:/localfile/OpenFPGA -w="/localfile/OpenFPGA" open_fpga bash<br /> - docker run -it --rm -v $PWD:/localfile/OpenFPGA -w="/localfile/OpenFPGA" open_fpga bash<br />
[*docker download link*](https://www.docker.com/products/docker-desktop) [*docker download link*](https://www.docker.com/products/docker-desktop)