From bb8f3f7eb8553a47ac1448233c8e993b737a67ac Mon Sep 17 00:00:00 2001
From: Sage Walker <cuby474@gmail.com>
Date: Wed, 3 May 2023 21:12:09 -0700
Subject: [PATCH] add rom to index

---
 docs/source/basic_rom_usage.md | 15 ++++++++++++++-
 docs/source/basic_usage.md     |  2 +-
 docs/source/index.md           |  3 ++-
 3 files changed, 17 insertions(+), 3 deletions(-)

diff --git a/docs/source/basic_rom_usage.md b/docs/source/basic_rom_usage.md
index cdb482b1..07356862 100644
--- a/docs/source/basic_rom_usage.md
+++ b/docs/source/basic_rom_usage.md
@@ -2,7 +2,7 @@
 ### [Go Back](./index.md#table-of-contents)
 
 # Basic Usage
-This page of the documentation explains the basic usage of OpenRAM's ROM compiler (OpenROM).
+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)
 
 
 
@@ -84,3 +84,16 @@ make sky130_rom_1kbyte
     # Add a supply ring to the generated layout
     route_supplies = "ring"
     ```
+
+
+## Output Files
+The output files are placed in the `output_dir` defined in the configuration
+file.
+
+The base name is specified by `output_name` and suffixes are added. Currently only layout and schematic files are generated.
+
+The final results files are:
+* GDS (.gds)
+* SPICE (.sp)
+* Log (.log)
+* Configuration (.py) for replication of creation
diff --git a/docs/source/basic_usage.md b/docs/source/basic_usage.md
index e9261f3d..01523418 100644
--- a/docs/source/basic_usage.md
+++ b/docs/source/basic_usage.md
@@ -1,7 +1,7 @@
 ### [Go Back](./index.md#table-of-contents)
 
 # Basic Usage
-This page of the documentation explains the basic usage of OpenRAM's SRAM compiler.
+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)
 
 
 
diff --git a/docs/source/index.md b/docs/source/index.md
index 720d5a63..94007f33 100644
--- a/docs/source/index.md
+++ b/docs/source/index.md
@@ -10,7 +10,8 @@ navigate through the documentation.
 1. [OpenRAM Dependencies](#openram-dependencies)
 1. [Supported Technologies](#supported-technologies)
 1. [Basic Setup](./basic_setup.md#go-back)
-1. [Basic Usage](./basic_usage.md#go-back)
+1. [Basic SRAM Usage](./basic_usage.md#go-back)
+1. [Basic ROM Usage](./basic_rom_usage.md#go-back)
 1. [Python Library](./python_library.md#go-back)
 1. [Bitcells](./bitcells.md#go-back)
 1. [Architecture](./architecture.md#go-back)