From 2ed34160172e77bd4c5a660508158f0e484fafa6 Mon Sep 17 00:00:00 2001
From: Matthew Guthaus <mrg@ucsc.edu>
Date: Tue, 3 Dec 2019 18:29:38 +0000
Subject: [PATCH] Smalle dits to README and HINTS

---
 HINTS.md  | 23 +++++++++++++++--------
 README.md | 26 +++++++++++++++++---------
 2 files changed, 32 insertions(+), 17 deletions(-)

diff --git a/HINTS.md b/HINTS.md
index b12704e5..6f29c16b 100644
--- a/HINTS.md
+++ b/HINTS.md
@@ -37,7 +37,15 @@ to run Calibre or Magic+Netgen.
 To debug, you will need a layout viewer. I prefer to use Glade 
 on my Mac, but you can also use Calibre, Magic, etc. 
 
-1. Calibre
+1. Klayout
+
+   You can view the designs in [Klayout](https://www.klayout.de/) with the configuration
+   file provided in the tech directories. For example,
+```
+  klayout temp.gds -l /home/vagrant/openram/technology/freepdk45/tf/FreePDK45.lyp
+```
+
+2. Calibre
 
    Start the Calibre DESIGNrev viewer in the temp directory and load your GDS file:
 ```
@@ -52,10 +60,9 @@ on my Mac, but you can also use Calibre, Magic, etc.
 
    In the viewer ">" opens the layout down a level.
 
-2. Glade
+3. Glade
 
-   You can view errors in Glade as well. I like this because it is on my laptop.
-   You can get it from:  http://www.peardrop.co.uk/glade/
+   You can view errors in [Glade](http://www.peardrop.co.uk/glade/) as well. 
 
    To remote display over X windows, you need to disable OpenGL acceleration or use vnc
    or something. You can disable by adding this to your .bashrc in bash:
@@ -82,16 +89,16 @@ ui().importCds("default",
    To load the errors, you simply do Verify->Import Calibre Errors select
    the .results file from Calibre.
 
-3. Magic
+4. Magic
 
    Magic is only supported in SCMOS. You will need to install the MOSIS SCMOS rules
-   and Magic from: http://opencircuitdesign.com/
+   and [Magic](http://opencircuitdesign.com/)
 
    When running DRC or extraction, OpenRAM will load the GDS file, save
    the .ext/.mag files, and export an extracted netlist (.spice).
 
-4. It is possible to use other viewers as well, such as:
-   * LayoutEditor http://www.layouteditor.net/ 
+5. It is possible to use other viewers as well, such as:
+   * [LayoutEditor](http://www.layouteditor.net/)
 
 
 # Example to output/input .gds layout files from/to Cadence
diff --git a/README.md b/README.md
index 05bb7772..f141b317 100644
--- a/README.md
+++ b/README.md
@@ -33,15 +33,6 @@ things that need to be fixed.
 
 # Basic Setup
 
-## Docker Image
-
-We have a pre-configured Ubuntu [Docker](https://www.docker.com/) image
-available that has all tools installed for the [SCMOS] process. It is
-available at [docker hub](https://hub.docker.com/r/vlsida/openram-ubuntu).
-Please see 
-[our README.md](https://github.com/VLSIDA/openram-docker-images/blob/master/README.md)
-for information on how to use this docker image.
-
 ## Dependencies
 
 The OpenRAM compiler has very few dependencies:
@@ -88,6 +79,23 @@ 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].
 
+## Docker Image
+
+We have a pre-configured Ubuntu [Docker](https://www.docker.com/) image
+available that has all tools installed for the [SCMOS] process. It is
+available at [docker hub](https://hub.docker.com/r/vlsida/openram-ubuntu).
+Please see 
+[our README.md](https://github.com/VLSIDA/openram-docker-images/blob/master/README.md)
+for information on how to use this docker image.
+
+## Vagrant Image
+
+We have a pre-configured Ubuntu [Vagrant](https://www.vagrantup.com/) image
+available that has all tools installed for the [SCMOS] process. 
+Please see 
+[our README.md](https://github.com/VLSIDA/openram-vagrant-image/blob/master/README.md)
+for information on how to use this image.
+
 # Basic Usage
 
 Once you have defined the environment, you can run OpenRAM from the command line