Create README.md

README.md

@@ -0,0 +1,45 @@
+## TIGFET10nm Open Source Predictive Process Design Kit v1.0  [MIT License]
+
+Copyright (c) [2019] [Laboratory for NanoIntegrated Systems]
+
+This repository is a process design kit for Cadence Virtuoso® describing a TIGFET 10nm silicon nanowire device technology. The design kit is derived using Synopsys Sentaurus TCAD® based device simulations.
+
+This kit consists of a SPICE model and full custom physical design files including a Design Rule Manual, a Design Rule Check, and a Layout Versus Schematic
+decks for Mentor Graphics Calibre®.
+
+### TIGFET10nm PDK Directory Structure
+
+* calibre/ -> SVRF rules for Mentor Graphics Calibre®
+* cdslib/  -> Technology libraires for Cadence Virtuoso and setup scripts
+* hspice/  -> Simulation models for Synopsys HSPICE®
+* doc/    -> Documentation
+
+For more detail about the key assumptions made while designing this PDK, please refer to the following publication:
+
+[*Ganesh Gore, Patsy Cadareanu, Edouard Giacomin, and Pierre-Emmanuel Gaillardon "A Predictive Process Design Kit for Three-Independent-Gate Field-Effect Transistors", 2019 IFIP/IEEE 27th International Conference on Very Large Scale Integration (VLSI-SoC), 6-9 October 2019.*](https://ieeexplore.ieee.org/abstract/document/8920358/)
+
+### Design Kit Installation and Usage (assuming a csh/tcsh shell)
+  1) Clone the github repository.
+  ```bash
+  git clone https://github.com/LNIS-Projects/TIGFET-10nm-PDK.git
+  cd TIGFET-10nm-PDK/
+  ```
+
+  2) Set the variable PDK_DIR to where the PDK folder is.
+  ```bash
+  setenv PDK_DIR "$PWD"
+  ```
+		 
+  3) Copy the required user files to where you want to start Virtuoso®. It is assumed here that Virtuoso is started in the Github folder itself.
+  ```bash
+  source $PDK_DIR/cdslib/setup/setup.csh
+  ```
+     
+  Note that this script copies all of the required user files (.cdsinit, cds.lib, and Calibre® runset files) to the current working directory if they do not already exist.
+
+  4) Source your setup scripts for Cadence Virtuoso®, Mentor Graphics Calibre®, and Synopsys HSPICE® and launch Cadence Virtuoso® using the provided script: 
+  ```bash 
+  source launch_tigfet10nm.sh
+  ```
+
+> In case of any doubts/questions/suggestions, please raise issue on GitHub or send an email to pierre-emmanuel.gaillardon@utah.edu or ganesh.gore@utah.edu.