diff --git a/README.md b/README.md index 25891d747..47621a371 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ OpenFPGA is an extension to VPR. It is an IP Verilog Generator allowing reliable ## Compilation The different ways of compiling can be found in the **./compilation** folder.
-Dependancies and help using docker can be found at **./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:** 1. Create a folder named build in OpenPFGA repository (mkdir build && cd build) diff --git a/tutorials/fpga_flow/how2use.md b/tutorials/fpga_flow/how2use.md index 000aee364..27c9b1db6 100644 --- a/tutorials/fpga_flow/how2use.md +++ b/tutorials/fpga_flow/how2use.md @@ -16,15 +16,11 @@ cd fpga_flow
By running this script we took an architecture description file, generated its netlist, generated a bitstream to implement a benchmark on it and verified this implementation.
When you open this file you can see that 2 scripts are called. The first one is **rewrite_path_in_file.pl** which allow us to make this tutorial generic by generating full path to dependancies.
-The second one is **fpga_flow.pl**. This script launch OpenFPGA flow and can be used with a lot of [options](https://github.com/LNIS-Projects/OpenFPGA/blob/documentation/tutorials/fpga_flow/options.md). In this example we activated all FPGA-Verilog options - - - -*Any script provides help if launch without argument* - -fpga_flow.pl has dependencies which need to be configured. They are: -* configuration file, which provides dependencies path and flow type -* benchmark list file +The second one is **fpga_flow.pl**. This script launch OpenFPGA flow and can be used with a lot of [options](https://github.com/LNIS-Projects/OpenFPGA/blob/documentation/tutorials/fpga_flow/options.md).
+There is 3 important things to see: +- All FPGA-Verilog options have been activated +- fpga_flow.pl calls a configuration file through "config_file" variable +- fpga_flow.pl calls a list of benchmark to implement and test through "bench_txt" variable ## Configuration file @@ -60,13 +56,13 @@ m2net_conf = not_used
mpack2_arch = not_used
power_tech_xml = **
-[csv_tags] *to complete*
+[csv_tags]
mpack1_tags = Global mapping efficiency:|efficiency:|occupancy wo buf:|efficiency wo buf:
mpack2_tags = BLE Number:|BLE Fill Rate:
vpr_tags = Netlist clb blocks:|Final critical path:|Total logic delay:|total net delay:|Total routing area:|Total used logic block area:|Total wirelength:|Packing took|Placement took|Routing took|Average net density:|Median net density:|Recommend no. of clock cycles:
vpr_power_tags = PB Types|Routing|Switch Box|Connection Box|Primitives|Interc Structures|lut6|ff
-*An example of this file can be found at OPENFPGAPATHKEYWORD/fpga_flow/configs/tutorial/tuto.conf* +*This example file can be found at OPENFPGAPATHKEYWORD/fpga_flow/configs/tutorial/tuto.conf* ## Benchmark list @@ -79,4 +75,4 @@ Blif and Verilog folders are organized by folders with the name of projects. **F The benchmark list file can contain as many benchmarks as available in the same folder targetted by "benchmark_dir" variable from the configuration file. It's written as:
top_module/*.v,; where is the number of channel/wire between each block. -*An example of this file can be found at OPENFPGAPATHKEYWORD/fpga_flow/benchmarks/List/tuto_benchmark.txt* +*This example file can be found at OPENFPGAPATHKEYWORD/fpga_flow/benchmarks/List/tuto_benchmark.txt*