From 61026dc623d59a8ea873597a96ebfd7d61237f8c Mon Sep 17 00:00:00 2001 From: tangxifan Date: Tue, 16 Jul 2019 16:58:11 -0400 Subject: [PATCH 1/2] Update building.md --- tutorials/building.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/tutorials/building.md b/tutorials/building.md index bc7bc28a9..7525493a4 100644 --- a/tutorials/building.md +++ b/tutorials/building.md @@ -1,8 +1,8 @@ # How to build? -## Dependancies +## Dependencies -OpenFPGA requires all the dependancies listed below: +OpenFPGA requires all the following dependencies: - autoconf - automake - bash @@ -40,18 +40,18 @@ OpenFPGA requires all the dependancies listed below: ## 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. A container ready to use can be created with the following command: +If all these dependancies are not installed on your machine, you can choose to use a Docker (the Docker tool needs to be installed). To ease customer first experience, a Dockerfile is provided in the OpenFPGA folder. A container ready to use can be created with the following command: - docker run lnis/open_fpga:release
*Warning: This command is for quick testing. If you want to conserve your work you should certainly use other options as "-v".* -Or a container where you can build OpenFPGA yourself can be created with the following commands: +Otherwise, a container where you can build OpenFPGA yourself can be created with the following commands: - docker build . -t open_fpga - docker run -it --rm -v $PWD:/localfile/OpenFPGA -w="/localfile/OpenFPGA" open_fpga bash
[*docker download link*](https://www.docker.com/products/docker-desktop) ## Building -To build the tool you have to be in OpenFPGA folder and do: +To build the tool you have to go in OpenFPGA folder and do: - mkdir build && cd build - cmake .. -DCMAKE_BUILD_TYPE=debug - make (*WARNING using docker you cannot use "make -j", errors will happen*) From 1da04b9c3a960805fe134e2726fe5a9bdcf31699 Mon Sep 17 00:00:00 2001 From: egiacomin Date: Wed, 17 Jul 2019 12:19:57 -0600 Subject: [PATCH 2/2] Update tutorial_index.md --- tutorials/tutorial_index.md | 24 +++++++++--------------- 1 file changed, 9 insertions(+), 15 deletions(-) diff --git a/tutorials/tutorial_index.md b/tutorials/tutorial_index.md index 8198fb6da..bbf95ff86 100644 --- a/tutorials/tutorial_index.md +++ b/tutorials/tutorial_index.md @@ -1,26 +1,20 @@ -# Tutorial introduction - -OpenFPGA an IP Verilog Generator allowing reliable and fast testing of homogeneous architectures.
-Its main goal is to easily and efficiently generated a complete customizable FPGA. It uses a semi-custom design technic.

-These tutorials are organized as follow: -* [Building the tool and his dependancies](https://github.com/LNIS-Projects/OpenFPGA/blob/master/tutorials/building.md) +# Tutorial Introduction +OpenFPGA is an IP Verilog Generator allowing reliable and fast testing of homogeneous FPGA architectures.
+Its main goal is to easily and efficiently generated a complete customizable FPGA and uses a semi-custom design flow.

+In order to help you get in touch with the software, we provide few tutorials which are organized as follow: +* [Building the tool and his dependencies](https://github.com/LNIS-Projects/OpenFPGA/blob/master/tutorials/building.md) * [Launching the flow and understand how it works](https://github.com/LNIS-Projects/OpenFPGA/blob/master/tutorials/fpga_flow/how2use.md) * Architecture modification -## Folder organization - +## Folder Organization OpenFPGA repository is organized as follow: * **abc**: open source synthesys tool * **ace2**: abc extension generating .act files +* **ace2**: abc extension generating activity files (.act) * **vpr7_x2p**: sources of modified vpr * **yosys**: opensource synthesys tool * **fpga_flow**: scripts and dependencies to run the complete flow -## Tips and informations - -Some keywords will be used during this tutorial: +## Tips and Information +Some keywords will be used during in the tutorials: * OPENFPGAPATHKEYWORD: refers to OpenFPGA folder full path - - - -