Skip to content

Commit 32bb224

Browse files
committed
Update workspace name and README.
1 parent c38bb19 commit 32bb224

File tree

2 files changed

+43
-2
lines changed

2 files changed

+43
-2
lines changed

README.md

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,43 @@
11
# rules_verilog
2-
Utilities for working with Verilog within Bazel.
2+
3+
Utilities for working with Verilog within [Bazel](https://bazel.build/).
4+
5+
## gtkwave_wrapper
6+
7+
Wrapper for [GTKWave](http://gtkwave.sourceforge.net/) to view traces generated by Bazel rules.
8+
9+
## verilog_module
10+
11+
Bazel representation of a Verilog module's source files, dependencies, and top module.
12+
13+
```Starlark
14+
load("@rules_verilog//verilog:defs.bzl", "verilog_module")
15+
16+
verilog_module(
17+
name = "counter",
18+
top = "counter",
19+
srcs = ["counter.sv"],
20+
)
21+
22+
verilog_module(
23+
name = "counter_top",
24+
top = "counter_top",
25+
srcs = [
26+
"counter_top.sv",
27+
],
28+
deps = [":counter"],
29+
)
30+
```
31+
32+
## WORKSPACE
33+
34+
To incorporate `rules_verilog` into your project at the following to your `WORKSPACE` file.
35+
36+
```Starlark
37+
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
38+
39+
http_archive(
40+
name = "rules_verilog",
41+
# See release page for latest version url and sha.
42+
)
43+
```

WORKSPACE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
workspace(name = "bazel_hdl")
1+
workspace(name = "rules_verilog")

0 commit comments

Comments
 (0)