Merge pull request #134 from mabrains/gf180_updates
Adding docs for GF180 variants, Updating makefile
diff --git a/Makefile b/Makefile
index dcd8a7a..d3428e1 100644
--- a/Makefile
+++ b/Makefile
@@ -89,3 +89,12 @@
# LVS main testing
test-LVS-switch: | $(CONDA_ENV_PYTHON)
@$(IN_CONDA_ENV) klayout -v
+
+#================================
+# ---------- GEN-SVG ------------
+#================================
+
+# Generate SVGs
+gen-svg: | $(CONDA_ENV_PYTHON)
+ @which python3
+ @$(IN_CONDA_ENV) python3 ./scripts/generate_svg.py .
diff --git a/README.md b/README.md
index 7e4e199..90dad84 100644
--- a/README.md
+++ b/README.md
@@ -2,12 +2,49 @@
GF180 technology development Shared Repo
+
+## **GF180 Technology Variants Status**
+
+|GF180 variant|DRC |DRC testing |LVS |LVS testing |Models-ngspice|Models-ngspice testing|
+|-------------|------------------|------------------|------------------|------------------|--------------|----------------------|
+|BCDLite |[:heavy_check_mark:](https://github.com/mabrains/gf180_technology_dev/tree/main/BCDLite/klayout/drc)|[:heavy_check_mark:](https://github.com/mabrains/gf180_technology_dev/tree/main/BCDLite/klayout/drc/testing)|[:heavy_check_mark:](https://github.com/mabrains/gf180_technology_dev/tree/main/BCDLite/klayout/lvs)|[:heavy_check_mark:](https://github.com/mabrains/gf180_technology_dev/tree/main/BCDLite/klayout/lvs/testing)|:x: |:x: |
+|ULL |[:heavy_check_mark:](https://github.com/mabrains/gf180_technology_dev/tree/main/ULL/klayout/drc)|[:heavy_check_mark:](https://github.com/mabrains/gf180_technology_dev/tree/main/ULL/klayout/drc/testing)|[:heavy_check_mark:](https://github.com/mabrains/gf180_technology_dev/tree/main/ULL/klayout/lvs)|[:heavy_check_mark:](https://github.com/mabrains/gf180_technology_dev/tree/main/ULL/klayout/lvs/testing)|:x: |:x: |
+|IC |[:heavy_check_mark:](https://github.com/mabrains/gf180_technology_dev/tree/main/IC/klayout/drc)|[:heavy_check_mark:](https://github.com/mabrains/gf180_technology_dev/tree/main/IC/klayout/drc/testing)|[:heavy_check_mark:](https://github.com/mabrains/gf180_technology_dev/tree/main/IC/klayout/lvs)|[:heavy_check_mark:](https://github.com/mabrains/gf180_technology_dev/tree/main/IC/klayout/lvs/testing)|:x: |:x: |
+
+## Testing DRC and LVS for GF180 Variants
+
+To run DRC regression for GF180 variants, you could run the following commands;
+
+```bash
+make env
+make tes-DRC-<variant_name>-<table_name>
+```
+
+- Example
+```bash
+make env
+make tes-DRC-BCDLite-poly2
+```
+
+To run LVS regression for GF180 variants, you could run the following commands;
+
+```bash
+make env
+make tes-LVS-<variant_name>-<table_name>
+```
+
+- Example
+```bash
+make env
+make tes-LVS-BCDLite-MOS
+```
+
## Generating SVG for all unit tests
To generate all the svg files for the unit tests run the following commands;
```bash
make env
-make svg
+make gen-svg
```
This will run the [`./scripts/generate_svg.py`](./scripts/generate_svg.py) to
