Update READMEs

README.md

@@ -26,18 +26,22 @@ things that need to be fixed.
 
 # Basic Setup
 
+## Docker
+
+We have a [docker setup](./docker) to run OpenRAM.
+
 ## Dependencies
 
 The OpenRAM compiler has very few dependencies:
-+ [Ngspice] 26 (or later) or HSpice I-2013.12-1 (or later) or CustomSim 2017 (or later) or [Xyce] 7.2 (or later)
-+ Python 3.5 or higher
++ [Ngspice] 34 (or later) or HSpice I-2013.12-1 (or later) or CustomSim 2017 (or later) or [Xyce] 7.4 (or later)
++ Python 3.6 or higher
 + Various Python packages (pip install -r requirements.txt)
 + [Git]
 
 If you want to perform DRC and LVS, you will need either:
 + Calibre (for [FreePDK45])
-+ [Magic] 8.3.130 or newer
-+ [Netgen] 1.5.164 or newer
++ [Magic] 8.3.197 or newer
++ [Netgen] 1.5.195 or newer
 
 You must set two environment variables:
 + OPENRAM\_HOME should point to the compiler source directory.
@@ -58,19 +62,10 @@ You may also wish to add OPENRAM\_HOME to your PYTHONPATH:
   export PYTHONPATH="$PYTHONPATH:$OPENRAM_HOME"
 ```
 
-We include the tech files necessary for [SCMOS] SCN4M_SUBM. The
-[SCMOS] spice models, however, are generic and should be replaced with
-foundry models.  If you are using [FreePDK45], you should also have
-that set up and have the environment variable point to the PDK. For
-example add this to your .bashrc:
-
-```
-  export FREEPDK45="/bsoe/software/design-kits/FreePDK45"
-```
-
-You may get the entire [FreePDK45 PDK here][FreePDK45].
-If you are using [SCMOS], you should install [Magic] and [Netgen].
-We have included the most recent SCN4M_SUBM design rules from [Qflow].
+We include the tech files necessary for [SCMOS] SCN4M_SUBM,
+[FreePDK45], and [Sky130]. The [SCMOS] spice models, however, are
+generic and should be replaced with foundry models. You may get the
+entire [FreePDK45 PDK here][FreePDK45].
 
 # Basic Usage
 
@@ -203,7 +198,7 @@ If I forgot to add you, please let me know!
 
 [Github issues]:         https://github.com/VLSIDA/OpenRAM/issues
 [Github pull request]:   https://github.com/VLSIDA/OpenRAM/pulls
-[Github project]:       https://github.com/VLSIDA/OpenRAM
+[Github project]:         https://github.com/VLSIDA/OpenRAM
 
 [documentation]:         https://docs.google.com/presentation/d/10InGB33N51I6oBHnqpU7_w9DXlx-qe9zdrlco2Yc5co/edit?usp=sharing
 [dev-group]:             mailto:openram-dev-group@ucsc.edu
@@ -218,8 +213,8 @@ If I forgot to add you, please let me know!
 [Xyce]:                  http://xyce.sandia.gov/
 [Git]:                   https://git-scm.com/
 
-[OSUPDK]:                https://vlsiarch.ecen.okstate.edu/flow/
 [FreePDK45]:             https://www.eda.ncsu.edu/wiki/FreePDK45:Contents
 [SCMOS]:                 https://www.mosis.com/files/scmos/scmos.pdf
+[Sky130]:                https://github.com/google/skywater-pdk-libs-sky130_fd_bd_sram.git
 
 [Slack]:                 https://join.slack.com/t/openram/shared_invite/enQtNDgxMjc3NzU5NTI1LWZiYWMwNjNkZThmYTdkODc3NDE1NDhjNzUxNDhmMDQ4ZTM3NDgwNWFlNjM5NWFiZDkyMzBlNzc1NTg3ZjllNTY

docker/README.md

@@ -0,0 +1,47 @@
+# Docker images for OpenRAM #
+
+## Installing Docker ##
+
+There are a number of ways to install Docker.  Pick your favorite.
+
+* On Mac from docker.com with .app:
+ https://docs.docker.com/docker-for-mac/install/
+
+* On Windows from docker.com:
+ https://docs.docker.com/docker-for-windows/install/
+
+* On Ubuntu:
+ https://docs.docker.com/install/linux/docker-ce/ubuntu/
+
+NOTE: If you plan to use a VPN, do *NOT* use the Docker Toolbox for
+Mac or the docker from [Macports](https://www.macports.org/
+"Macports") as these require a network socket that breaks when you
+install some VPN software. To understand the difference, check out [this
+page](https://docs.docker.com/docker-for-mac/docker-toolbox/).
+
+## Running Docker ##
+
+### Terminal only ###
+
+* To run as a generic user:
+```
+make mount
+```
+
+## Updating the image ##
+
+If there are updates to the image, you can pull a new one from the hub with:
+```
+make pull
+```
+This is not automatically done, so if you have a problem, make sure you are up-to-date.
+
+## Building your own image ##
+
+You can run the build script to build a local image:
+
+```
+make build
+```
+
+If you want to change things, modify the openram-ubuntu/Dockerfile and let me know what should be fixed.