From 26814f92ef3063299d657b039a4d58d377df63ab Mon Sep 17 00:00:00 2001 From: Matt Guthaus Date: Fri, 16 Nov 2018 08:25:04 -0800 Subject: [PATCH] Clarify basic setup instructions. --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 38b906b5..4d342362 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # OpenRAM -Master: [![pipeline status](https://scone.soe.ucsc.edu:8888/mrg/PrivateRAM/badges/master/pipeline.svg?private_token=ynB6rSFLzvKUseoBPcwV)](https://github.com/VLSIDA/PrivateRAM/commits/master) -Dev: [![pipeline status](https://scone.soe.ucsc.edu:8888/mrg/PrivateRAM/badges/dev/pipeline.svg?private_token=ynB6rSFLzvKUseoBPcwV)](https://github.com/VLSIDA/PrivateRAM/commits/dev) -[![Download](images/download.svg)](https://github.com/VLSIDA/PrivateRAM/archive/dev.zip) +Stable: [![pipeline status](https://scone.soe.ucsc.edu:8888/mrg/PrivateRAM/badges/master/pipeline.svg?private_token=ynB6rSFLzvKUseoBPcwV)](https://github.com/VLSIDA/PrivateRAM/commits/master) +Unstable: [![pipeline status](https://scone.soe.ucsc.edu:8888/mrg/PrivateRAM/badges/dev/pipeline.svg?private_token=ynB6rSFLzvKUseoBPcwV)](https://github.com/VLSIDA/PrivateRAM/commits/dev) +[![Download](images/download.svg)](https://github.com/VLSIDA/PrivateRAM/archive/master.zip) [![License: BSD 3-clause](./images/license_badge.svg)](./LICENSE) An open-source static random access memory (SRAM) compiler. @@ -39,6 +39,12 @@ For example add this to your .bashrc: export OPENRAM_TECH="$HOME/openram/technology" ``` +You may also wish to add OPENRAM\_HOME to your PYTHONPATH: + +``` + export PYTHONPATH="$PYTHONPATH:$OPENRAM_HOME" +``` + We include the tech files necessary for [FreePDK45] and [SCMOS] SCN4M_SUBM. The [SCMOS] spice models, however, are generic and should be replaced with foundry models. If you are using [FreePDK45], you @@ -56,8 +62,7 @@ We have included the most recent SCN4M_SUBM design rules from [Qflow]. # Basic Usage Once you have defined the environment, you can run OpenRAM from the command line -using a single configuration file written in Python. You may wish to add -$OPENRAM\_HOME to your $PYTHONPATH. +using a single configuration file written in Python. For example, create a file called *myconfig.py* specifying the following parameters for your memory: