Move library documentation to its own page

This commit is contained in:
Eren Dogan
2023-03-15 12:40:04 -07:00
parent c0d9941985
commit 4994e3ddde
4 changed files with 109 additions and 120 deletions
+1 -25
View File
@@ -7,7 +7,6 @@ This page shows the basic setup for using OpenRAM.
## Table of Contents
1. [Dependencies](#dependencies)
1. [OpenRAM Library](#openram-library)
1. [Anaconda](#anaconda)
1. [Docker](#docker-deprecated-use-anaconda-instead)
1. [Environment](#environment)
@@ -16,8 +15,6 @@ This page shows the basic setup for using OpenRAM.
## Dependencies
Please see the Dockerfile for the required versions of tools.
In general, the OpenRAM compiler has very few dependencies:
+ Git
+ Make
@@ -27,28 +24,6 @@ In general, the OpenRAM compiler has very few dependencies:
## OpenRAM Library
OpenRAM is available as a Python library. There are a few ways to install it:
+ Install the latest _stable_ version with pip:
```
pip3 install openram
```
+ Install the latest _dev_ version:
```
pip3 install git+https://[email protected]/VLSIDA/OpenRAM.git@dev
```
+ Install using Makefile (you need to clone the repo):
```
git clone [email protected]:VLSIDA/OpenRAM.git
cd OpenRAM
make library
```
## Anaconda
We use Anaconda package manager to install the tools used by OpenRAM. This way, you don't have to
worry about updating/installing these tools. OpenRAM installs Anaconda silently in the background
@@ -142,3 +117,4 @@ You can also run these from the package installation directory if you have the O
[SCMOS]: https://www.mosis.com/files/scmos/scmos.pdf
[FreePDK45]: https://www.eda.ncsu.edu/wiki/FreePDK45:Contents
[Sky130]: https://github.com/google/skywater-pdk-libs-sky130_fd_bd_sram.git