docs: Improving the README.md files. Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
diff --git a/docs/.gitignore b/docs/.gitignore index f7a3e54..41489e9 100644 --- a/docs/.gitignore +++ b/docs/.gitignore
@@ -1,2 +1,3 @@ +venv _build tests/*.md
diff --git a/docs/index.rst b/docs/index.rst index 605e9e5..f419b60 100644 --- a/docs/index.rst +++ b/docs/index.rst
@@ -13,4 +13,39 @@ :glob: :caption: Tests + Verilog to Routing Examples + - Primitive Block Timing Modeling Tutorial + - tests/fig28-lutff-pair.md + - tests/fig41-full-adder.md + - tests/fig42-dff.md + + Clock Example + - FlipFlop Examples + - tests/clocks/dff_comb_one_clock.md + - tests/clocks/dff_one_clock.md + - tests/clocks/dff_two_clocks.md + - Input Clocks + - tests/clocks/input_attr_clock.md + - tests/clocks/input_named_clk.md + - tests/clocks/input_named_rdclk.md + - Output Clocks + - tests/clocks/output_attr_clock.md + - tests/clocks/output_named_clk.md + - tests/clocks/output_named_rdclk.md + - Multiple Clocks + - tests/clocks/multiple_inputs_named_clk.md + - tests/clocks/multiple_outputs_named_clk.md + + Carry Example + - tests/carry.md + + DSP Examples + - tests/dsp_combinational.md + - tests/dsp_in_registered.md + - tests/dsp_out_registered.md + - tests/dsp_inout_registered.md + - tests/dsp_inout_registered_dualclk.md + - tests/dsp_partial_registered.md + - tests/dsp_modes.md + tests/**
diff --git a/tests/carry/README.md b/tests/carry/README.md index 54c81a8..75bfe5a 100644 --- a/tests/carry/README.md +++ b/tests/carry/README.md
@@ -1,4 +1,4 @@ -## CARRY tests +# `carry` tests This directory contains test for the `v2x_to_model.py` and `v2x_to_pb_type` tools. The tests use model defined in CBLOCK tests.
diff --git a/tests/carry/cblock/README.md b/tests/carry/cblock/README.md index ea82a59..032f831 100644 --- a/tests/carry/cblock/README.md +++ b/tests/carry/cblock/README.md
@@ -1,4 +1,4 @@ -## CARRY tests +# `carry` - `cblock` tests This directory contains test for the `v2x_to_model.py` and `v2x_to_pb_type` tools. Those tests should check the following features: @@ -17,6 +17,6 @@ - [ ] carry chains inference - carry chains defined on wires with `carry` attribute should be propagated to pb\_type xml file -## Timings +## Timing - - [ ] all the timings defined in Verilog should be propagated to result pb\_type file + - [ ] all the timing defined in Verilog should be propagated to result pb\_type file
diff --git a/tests/clocks/README.md b/tests/clocks/README.md index 752921f..e762b25 100644 --- a/tests/clocks/README.md +++ b/tests/clocks/README.md
@@ -1,4 +1,4 @@ -## Clock detection tests +# `clocks` tests This directory contains test for the clock detection functionality for the `v2x_to_model.py` tool.
diff --git a/tests/dsp_combinational/README.md b/tests/dsp_combinational/README.md index d83bc78..cd31b4f 100644 --- a/tests/dsp_combinational/README.md +++ b/tests/dsp_combinational/README.md
@@ -1,4 +1,4 @@ -## dsp\_combinational tests +# `dsp_combinational` tests This directory contains test for the blackbox detection for the `v2x_to_model.py` and `v2x_to_pb_type` tools.
diff --git a/tests/dsp_in_registered/README.md b/tests/dsp_in_registered/README.md index 15da4a4..70ffab9 100644 --- a/tests/dsp_in_registered/README.md +++ b/tests/dsp_in_registered/README.md
@@ -1,4 +1,4 @@ -## dsp\_in\_registered tests +# `dsp_in_registered` tests This directory contains test for the `v2x_to_model.py` and `v2x_to_pb_type` tools. The tests use model from fig42-dff and dps\_combinational tests.
diff --git a/tests/dsp_inout_registered/README.md b/tests/dsp_inout_registered/README.md index 950806c..8e053df 100644 --- a/tests/dsp_inout_registered/README.md +++ b/tests/dsp_inout_registered/README.md
@@ -1,4 +1,4 @@ -## dsp\_inout\_registered tests +# `dsp_inout_registered` tests This directory contains test for the `v2x_to_model.py` and `v2x_to_pb_type` tools. The tests use model from fig42-dff and dps\_combinational tests.
diff --git a/tests/dsp_inout_registered_dualclk/README.md b/tests/dsp_inout_registered_dualclk/README.md index 39fc8a9..35c81b3 100644 --- a/tests/dsp_inout_registered_dualclk/README.md +++ b/tests/dsp_inout_registered_dualclk/README.md
@@ -1,4 +1,4 @@ -## dsp\_inout\_registered\_dualclk tests +# `dsp_inout_registered_dualclk` tests This directory contains test for the `v2x_to_model.py` and `v2x_to_pb_type` tools. The tests use model from fig42-dff and dps\_combinational tests.
diff --git a/tests/dsp_modes/README.md b/tests/dsp_modes/README.md index 728a5c4..f40e36b 100644 --- a/tests/dsp_modes/README.md +++ b/tests/dsp_modes/README.md
@@ -1,4 +1,4 @@ -## dsp\_modes tests +# `dsp_modes` tests This directory contains test for the `v2x_to_model.py` and `v2x_to_pb_type` tools. The tests use models from other DSP test.
diff --git a/tests/dsp_out_registered/README.md b/tests/dsp_out_registered/README.md index 59b24f7..f0811bf 100644 --- a/tests/dsp_out_registered/README.md +++ b/tests/dsp_out_registered/README.md
@@ -1,4 +1,4 @@ -## dsp\_out\_registered tests +# `dsp_out_registered` tests This directory contains test for the `v2x_to_model.py` and `v2x_to_pb_type` tools. The tests use model from fig42-dff and dps\_combinational tests.
diff --git a/tests/dsp_partial_registered/README.md b/tests/dsp_partial_registered/README.md index 373bbf9..1de3cea 100644 --- a/tests/dsp_partial_registered/README.md +++ b/tests/dsp_partial_registered/README.md
@@ -1,4 +1,4 @@ -## dsp\_partial\_registered tests +# `dsp_partial_registered` tests This directory contains test for the `v2x_to_model.py` and `v2x_to_pb_type` tools. The tests use model from fig42-dff and dps\_combinational tests.
diff --git a/tests/fig28-lutff-pair/README.md b/tests/fig28-lutff-pair/README.md index 765f972..49792b3 100644 --- a/tests/fig28-lutff-pair/README.md +++ b/tests/fig28-lutff-pair/README.md
@@ -1,4 +1,4 @@ -## PAIR tests +# `fig28-lutff-pair` test This directory contains test for the `v2x_to_model.py` and `v2x_to_pb_type` tools. The tests use models defined in ff, lut and omux tests.
diff --git a/tests/fig28-lutff-pair/lut/README.md b/tests/fig28-lutff-pair/lut/README.md index fc2da7b..0781ed1 100644 --- a/tests/fig28-lutff-pair/lut/README.md +++ b/tests/fig28-lutff-pair/lut/README.md
@@ -1,4 +1,4 @@ -## LUT tests +# `fig28-lutff-pair` - `lut` test This directory contains test for the `v2x_to_model.py` and `v2x_to_pb_type` tools. Those tests should check the following features:
diff --git a/tests/fig41-full-adder/README.md b/tests/fig41-full-adder/README.md index 2af60b0..e08513f 100644 --- a/tests/fig41-full-adder/README.md +++ b/tests/fig41-full-adder/README.md
@@ -1,4 +1,4 @@ -## Adder tests +# `fig41-full-adder` test This directory contains test for the blackbox detection for the `v2x_to_model.py` and `v2x_to_pb_type` tools.
diff --git a/tests/fig42-dff/README.md b/tests/fig42-dff/README.md index d3e6290..0cbaf6f 100644 --- a/tests/fig42-dff/README.md +++ b/tests/fig42-dff/README.md
@@ -1,4 +1,4 @@ -## DFF tests +# `fig42-dff` test This directory contains tests for the `v2x_to_model.py` and `v2x_to_pb_type` tools.
diff --git a/tests/logicbox/README.md b/tests/logicbox/README.md index fb085d6..8c99e7f 100644 --- a/tests/logicbox/README.md +++ b/tests/logicbox/README.md
@@ -1,4 +1,4 @@ -## DFF tests +# Logicbox test This directory contains tests for the `v2x_to_model.py` and `v2x_to_pb_type` tools.
diff --git a/tests/multiple_instance/README.md b/tests/multiple_instance/README.md index 40e9777..c340c8a 100644 --- a/tests/multiple_instance/README.md +++ b/tests/multiple_instance/README.md
@@ -1,4 +1,4 @@ -## Multiple instance tests +# Multiple Instance test This directory contains tests for the `v2x_to_model.py` and `v2x_to_pb_type` tools.
diff --git a/tests/muxes/README.md b/tests/muxes/README.md index ad84528..836db79 100644 --- a/tests/muxes/README.md +++ b/tests/muxes/README.md
@@ -1,4 +1,4 @@ -## Routing muxes tests +# Routing Mux tests This directory contains tests for the `v2x_to_model.py` and `v2x_to_pb_type` tools.
diff --git a/tests/simple_pll/README.md b/tests/simple_pll/README.md index 3459bfa..a0c1399 100644 --- a/tests/simple_pll/README.md +++ b/tests/simple_pll/README.md
@@ -1,4 +1,4 @@ -## PLL tests +# Simple PLL test This directory contains tests for the `v2x_to_model.py` and `v2x_to_pb_type` tools.