luke
/
OpenRAM
mirror of https://github.com/VLSIDA/OpenRAM.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

More formatting for README.md

This commit is contained in:
Matt Guthaus 2017-11-09 11:24:42 -08:00
parent 4e3f90cbcd
commit 93e24c4651
1 changed files with 18 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@ -1,40 +1,39 @@
# BASIC SETUP # BASIC SETUP
- Please look at the OpenRAM ICCAD paper and presentation in the repository: Please look at the OpenRAM ICCAD paper and presentation in the repository:
https://github.com/mguthaus/OpenRAM/blob/master/OpenRAM_ICCAD_2016_paper.pdf https://github.com/mguthaus/OpenRAM/blob/master/OpenRAM_ICCAD_2016_paper.pdf
https://github.com/mguthaus/OpenRAM/blob/master/OpenRAM_ICCAD_2016_presentation.pdf https://github.com/mguthaus/OpenRAM/blob/master/OpenRAM_ICCAD_2016_presentation.pdf
- The OpenRAM compiler has very few dependencies: The OpenRAM compiler has very few dependencies:
* ngspice-26 or later or HSpice I-2013.12-1 or later * ngspice-26 or later or HSpice I-2013.12-1 or later
* Python 2.7 and higher (currently excludes Python 3 and up) * Python 2.7 and higher (currently excludes Python 3 and up)
* a setup script for each technology * a setup script for each technology
* a technology directory for each technology with the base cells * a technology directory for each technology with the base cells
- You must set two environment variables: OPENRAM_HOME should point to
the compiler source directory. OPENERAM_TECH should point to a root
technology directory that contains subdirs of all other technologies.
For example, in bash, add to your .bashrc:
You must set two environment variables: OPENRAM_HOME should point to
the compiler source directory. OPENERAM_TECH should point to a root
technology directory that contains subdirs of all other technologies.
For example, in bash, add to your .bashrc:
``` ```
export OPENRAM_HOME="$HOME/OpenRAM/compiler" export OPENRAM_HOME="$HOME/OpenRAM/compiler"
export OPENRAM_TECH="$HOME/OpenRAM/technology" export OPENRAM_TECH="$HOME/OpenRAM/technology"
``` ```
For example, in csh/tcsh, add to your .cshrc/.tcshrc: For example, in csh/tcsh, add to your .cshrc/.tcshrc:
``` ```
setenv OPENRAM_HOME "$HOME/OpenRAM/compiler" setenv OPENRAM_HOME "$HOME/OpenRAM/compiler"
setenv OPENRAM_TECH "$HOME/OpenRAM/technology" setenv OPENRAM_TECH "$HOME/OpenRAM/technology"
``` ```
- If you are using FreePDK, you should also have that set up and have the If you are using FreePDK, you should also have that set up and have the
environment variable point to the PDK. environment variable point to the PDK.
For example, in bash, add to your .bashrc: For example, in bash, add to your .bashrc:
``` ```
export FREEPDK45="/bsoe/software/design-kits/FreePDK45" export FREEPDK45="/bsoe/software/design-kits/FreePDK45"
``` ```
For example, in csh/tcsh, add to your .tcshrc: For example, in csh/tcsh, add to your .tcshrc:
``` ```
setenv FREEPDK45 "/bsoe/software/design-kits/FreePDK45" setenv FREEPDK45 "/bsoe/software/design-kits/FreePDK45"
``` ```
We do not distribute the PDK, but you may get it from: We do not distribute the PDK, but you may get it from:
https://www.eda.ncsu.edu/wiki/FreePDK45:Contents https://www.eda.ncsu.edu/wiki/FreePDK45:Contents