Skip to content

Commit

Permalink
Add link to examples in README
Browse files Browse the repository at this point in the history
Signed-off-by: Daniel Lim Wee Soong <[email protected]>
  • Loading branch information
daniellimws committed May 21, 2020
1 parent 655b757 commit 409a3da
Show file tree
Hide file tree
Showing 2 changed files with 330 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,10 @@ conda XXXX

* `netlistsvg`

## New Directives
## Usage

The `verilog-diagram` RST directive can be used to generate a diagram from Verilog code and include it in your documentation.
Check out the [examples](https://sphinxcontrib-verilog-diagrams.readthedocs.io/en/latest/) to see how to use it.

```rst
Expand All @@ -72,7 +75,9 @@ conda XXXX
```

Verilog Diagram Types;
### Options

`:type:` - Verilog Diagram Types;

* `yosys-blackbox` - Netlist rendered by Yosys.
* `yosys-aig` - Verilog file run through `aigmap` before image is generated directly in Yosys.
Expand All @@ -82,6 +87,12 @@ Verilog Diagram Types;

`:flatten:` - Use the Yosys `flatten` command before generating the image.

### Example

Here is a diagram of a 4-bit carry chain.

![4-bit carry chain](diagrams/carry4-flatten.svg)


## Licence

Expand Down
317 changes: 317 additions & 0 deletions diagrams/carry4-flatten.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 409a3da

Please sign in to comment.