diff --git a/README.md b/README.md index ed700daca..aa61fff7c 100644 --- a/README.md +++ b/README.md @@ -27,18 +27,11 @@ The different ways of compiling can be found in the **./compilation** folder. ## Documentation OpenFPGA's [full documentation](https://openfpga.readthedocs.io/en/master/) includes tutorials, descriptions of the design flow, and tool options. -## Examples +## Tutorial -You can find in the folder **./examples**. This will help you get in touch with the software and test different configurations to see how FPGA-SPICE reacts to them. - -./example_x.sh allows to launch the script linked to example_x.xml and .blif. - -In all the examples, the CLBs are composed of LUTs, FFs and MUXs as a base. - -Example 1 shows a very basic design with only 4 inputs on the LUTs, a FF and a MUX in the CLB (only 1). It implements an inverter and allows the user to see the very core of the .xml file. - -Example 2 increases the complexity by having 3x3 CLBs and 4 slices per CLB. The slices provide a feedback to the input structure and input MUXs are added. +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.