Skip to content

Commit

Permalink
Update workspace name and README.
Browse files Browse the repository at this point in the history
  • Loading branch information
agoessling committed Oct 25, 2020
1 parent c38bb19 commit 32bb224
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 2 deletions.
43 changes: 42 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,43 @@
# rules_verilog
Utilities for working with Verilog within Bazel.

Utilities for working with Verilog within [Bazel](https://bazel.build/).

## gtkwave_wrapper

Wrapper for [GTKWave](http://gtkwave.sourceforge.net/) to view traces generated by Bazel rules.

## verilog_module

Bazel representation of a Verilog module's source files, dependencies, and top module.

```Starlark
load("@rules_verilog//verilog:defs.bzl", "verilog_module")

verilog_module(
name = "counter",
top = "counter",
srcs = ["counter.sv"],
)

verilog_module(
name = "counter_top",
top = "counter_top",
srcs = [
"counter_top.sv",
],
deps = [":counter"],
)
```

## WORKSPACE

To incorporate `rules_verilog` into your project at the following to your `WORKSPACE` file.

```Starlark
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
name = "rules_verilog",
# See release page for latest version url and sha.
)
```
2 changes: 1 addition & 1 deletion WORKSPACE
Original file line number Diff line number Diff line change
@@ -1 +1 @@
workspace(name = "bazel_hdl")
workspace(name = "rules_verilog")

0 comments on commit 32bb224

Please sign in to comment.