[Doc] Add links to the technical summary in documentation for README

This commit is contained in:
tangxifan 2020-10-27 10:08:25 -06:00
parent 90e6021e43
commit 29431394a8
1 changed files with 34 additions and 25 deletions

View File

@ -3,40 +3,49 @@
[![Documentation Status](https://readthedocs.org/projects/openfpga/badge/?version=master)](https://openfpga.readthedocs.io/en/master/?badge=master)
## Introduction
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. 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.
A quick overview of OpenFPGA tools can be found [**here**](https://openfpga.readthedocs.io/en/master/tutorials/tools.html).
We also recommend potential users to checkout the summary of [**technical capabilities**](https://openfpga.readthedocs.io/en/master/overview/tech_highlights.html) before compiling.
## Compilation
<span style="color:red">Before start, we strongly recommend you to read the required dependencies at [**compilation guidelines**](./docs/source/tutorials/compile.rst).</span>
Before start, we strongly recommend you to read the required dependencies at [**compilation guidelines**](https://openfpga.readthedocs.io/en/master/tutorials/compile.html).
It also includes detailed information about docker image.
>**Compilation Steps:**
>
>```bash
># Clone the repository and go inside it
>git clone https://github.com/LNIS-Projects/OpenFPGA.git && cd OpenFPGA
>mkdir build && cd build # Create a folder named build in the OpenPFGA repository
>cmake .. # Create a Makefile in this folder using cmake
>make # Compile the tool and its dependencies
>```
---
>**Quick Compilation Verification**
>
>To quickly verify the tool is well compiled, user can run the following command from OpenFPGA root repository.
>```bash
>python3 openfpga_flow/scripts/run_fpga_task.py compilation_verification --debug --show_thread_logs
>```
>
>*Python3 and iVerilog v10.1+ are required. GUI will pop-up if enabled during compilation.*
**Compilation Steps:**
```bash
# Clone the repository and go inside it
git clone https://github.com/LNIS-Projects/OpenFPGA.git && cd OpenFPGA
mkdir build && cd build # Create a folder named build in the OpenPFGA repository
cmake .. # Create a Makefile in this folder using cmake
make # Compile the tool and its dependencies
```
>**Supported Operating Systems**
>
>> We currently target OpenFPGA for:
> 1. Ubuntu 18.04
> 2. Red Hat 7.5
>
>*The tool was tested with these operating systems. It might work with earlier versions and other distributions.*
---
**Quick Compilation Verification**
To quickly verify the tool is well compiled, user can run the following command from OpenFPGA root repository.
```bash
python3 openfpga_flow/scripts/run_fpga_task.py compilation_verification --debug --show_thread_logs
```
*Python3 and iVerilog v10.1+ are required. GUI will pop-up if enabled during compilation.*
---
**Supported Operating Systems**
We currently target OpenFPGA for:
1. Ubuntu 18.04
2. Red Hat 7.5
*The tool was tested with these operating systems. It might work with earlier versions and other distributions.*
## Documentation