luke/OpenRAM
1
0
Fork 0
mirror of https://github.com/VLSIDA/OpenRAM.git synced 2026-08-30 09:58:33 +02:00
Code Issues Packages Projects Releases Wiki Activity

Cleanup documentation

Browse Source
This commit is contained in:
Eren Dogan
2023-03-16 14:10:22 -07:00
parent 0fe8b3be17
commit c8b5b81bd8
4 changed files with 63 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/source/basic_usage.md
+6 -5
View File
@@ -17,11 +17,11 @@ This page of the documentation explains the basic usage of OpenRAM.
## Environment Variable Setup (assuming bash)
> **Note**: This is optional if you have the OpenRAM library.
> See [Python library](./python_library.md#go-back) for details.
* OPENRAM\_HOME defines where the compiler directory is
> **Note**: This is optional if you have the OpenRAM library. See
> [Python library](./python_library.md#go-back) for details.
* `OPENRAM_HOME` defines where the compiler directory is
* `export OPENRAM_HOME="$HOME/openram/compiler"`
* OPENRAM\_TECH defines list of paths where the technologies exist
* `OPENRAM_TECH` defines list of paths where the technologies exist
* `export OPENRAM_TECH="$HOME/openram/technology"`
* Colon separated list so you can have private technology directories
* Must also have any PDK related variables set up
@@ -131,7 +131,8 @@ OpenRAM is also available as a Python library. See
## Output Files
The output files are placed in the `output_dir` defined in the configuration file.
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.