Skip to content

Commit

Permalink
update docs after DesignDescription schema change
Browse files Browse the repository at this point in the history
  • Loading branch information
mszalkowski-ant committed Aug 30, 2024
1 parent a2ad346 commit e9118b7
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 6 deletions.
5 changes: 2 additions & 3 deletions docs/source/description_files.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,10 @@ You can see example design files in `examples` directory. The structure is as be

```yaml
ips:
# specify relations between IPs names in the design yaml
# and IP cores description yamls and modules
# specify relations between IPs instance names in the
# design yaml and IP cores description yamls
{ip_instance_name}:
file: {path_to_yaml_file_of_the_ip}
module: {name_of_the_HDL_module}
...

design:
Expand Down
3 changes: 0 additions & 3 deletions docs/source/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,13 +88,10 @@ signals:
ips:
vexriscv_instance:
file: ipcores/gen_VexRiscv.yaml
module: VexRiscv
wb_ram_data_instance:
file: ipcores/gen_mem.yaml
module: mem
wb_ram_instr_instance:
file: ipcores/gen_mem.yaml
module: mem
```

Expand Down

0 comments on commit e9118b7

Please sign in to comment.