Skip to content

Commit bb8f3f7

Browse files
add rom to index
1 parent a5a0cff commit bb8f3f7

File tree

3 files changed

+17
-3
lines changed

3 files changed

+17
-3
lines changed

docs/source/basic_rom_usage.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
### [Go Back](./index.md#table-of-contents)
33

44
# Basic Usage
5-
This page of the documentation explains the basic usage of OpenRAM's ROM compiler (OpenROM).
5+
This page of the documentation explains the basic usage of OpenRAM's ROM compiler (OpenROM). For usage of the RAM compiler see [here](./basic_usage.md#go-back)
66

77

88

@@ -84,3 +84,16 @@ make sky130_rom_1kbyte
8484
# Add a supply ring to the generated layout
8585
route_supplies = "ring"
8686
```
87+
88+
89+
## Output Files
90+
The output files are placed in the `output_dir` defined in the configuration
91+
file.
92+
93+
The base name is specified by `output_name` and suffixes are added. Currently only layout and schematic files are generated.
94+
95+
The final results files are:
96+
* GDS (.gds)
97+
* SPICE (.sp)
98+
* Log (.log)
99+
* Configuration (.py) for replication of creation

docs/source/basic_usage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
### [Go Back](./index.md#table-of-contents)
22

33
# Basic Usage
4-
This page of the documentation explains the basic usage of OpenRAM's SRAM compiler.
4+
This page of the documentation explains the basic usage of OpenRAM's SRAM compiler. For usage of the ROM compiler see [here](./basic_rom_usage.md#go-back)
55

66

77

docs/source/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ navigate through the documentation.
1010
1. [OpenRAM Dependencies](#openram-dependencies)
1111
1. [Supported Technologies](#supported-technologies)
1212
1. [Basic Setup](./basic_setup.md#go-back)
13-
1. [Basic Usage](./basic_usage.md#go-back)
13+
1. [Basic SRAM Usage](./basic_usage.md#go-back)
14+
1. [Basic ROM Usage](./basic_rom_usage.md#go-back)
1415
1. [Python Library](./python_library.md#go-back)
1516
1. [Bitcells](./bitcells.md#go-back)
1617
1. [Architecture](./architecture.md#go-back)

0 commit comments

Comments
 (0)