diff --git a/README.md b/README.md new file mode 100644 index 0000000..fa12e7d --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# Recepteur LIN +Circuit design project, ETN4 + +## Usage +Uses [fusesoc](http://fusesoc.net/) for building with [GHDL](http://ghdl.free.fr/) for the compilation and [Vivado](https://www.xilinx.com/developer/products/vivado.html) for the synthesis/implementation. + +### Simulate the whole design +`fusesoc run --target=sim etn4:conceptionCircuit:recepteurLIN:1.0.0` + +Generate a .ghw wave file in `build/etn4_conceptionCircuit_recepteurLIN_1.0.0/sim-ghdl/waveform.ghw` readable with [GTKWave](https://gtkwave.sourceforge.net/) for example. + +### Synthesize the whole design +`fusesoc run --target=synth etn4:conceptionCircuit:recepteurLIN:1.0.0` + +Generate a .xpr file in `build/etn4_conceptionCircuit_recepteurLIN_1.0.0/synth-vivado/etn4_conceptionCircuit_recepteurLIN_1.0.0.xpr` readable in Vivado.