Change deps/ to ip/ for compatibility with IPM

README.md

@@ -17,10 +17,10 @@ The template is set up for the common open source EDA tools for analog design. T
 ## Filesystem Structure
 
 - `cace/` - CACE datasheet and files
-- `deps/` - dependencies (not used in this simple example)
 - `docs/` - documentation generated by CACE
 - `gds/` - GDSII layout
   - `sky130_ef_ip__template.gds.gz`
+- `ip/` - IP blocks that the project depends on (not used in this simple example)
 - `mag/` - magic layout
   - `sky130_ef_ip__template.mag`
 - `xschem/` - files for xschem
@@ -33,22 +33,49 @@ The template is set up for the common open source EDA tools for analog design. T
 - `runs/` - run directory generated by CACE (not commited)
 - `.github/actions/cace.yaml` - GitHub Action to run CACE
 
+```bash
+.
+├── cace - CACE datasheet and files
+├── docs - documentation generated by CACE
+├── gds - GDSII layout
+│   └── sky130_ef_ip__template.gds.gz
+├── ip - IP blocks that the project depends on (not used in this simple example)
+├── LICENSE
+├── mag - magic layout
+│   └── sky130_ef_ip__template.mag
+├── netlist - spice netlists generated by CACE
+├── README.md
+├── runs - run directory generated by CACE (not commited)
+├── xschem - files for xschem
+│   ├── sky130_ef_ip__template - project internal symbols and schematics
+│   ├── sky130_ef_ip__template.sch - top level schematic
+│   │   └── …
+│   ├── sky130_ef_ip__template.sym - top level symbol
+│   ├── sky130_ef_ip__template_tb.sch - top level testbench
+│   └── xschemrc - project xschemrc (must be sourced)
+├── .github
+│   └── workflows
+│       └── cace.yml - GitHub Action to run CACE
+└── .gitignore
+```
+
+
 Note: If your project does not use magic layout files, simply delete the `mag/` folder and provide the GDS directly in `gds/`.
 
 ## Dependency Management
 
-Other IP blocks following this convention can be added as a git submodule in the `deps/` folder.
+Other IP blocks following this convention can be added as a git submodule in the `ip/` folder.
 
 This command expects the IP block to belong to the same user as the superproject:
 
 ```
-git submodule add ../<ip_block>.git deps/<ip_block>
+git submodule add ../<ip_block>.git ip/<ip_block>
 ```
 
 This command expects the IP block to be hosted on GitHub by a different user:
 
 ```
-git submodule add ../../<user>/<ip_block>.git deps/<ip_block>
+git submodule add ../../<user>/<ip_block>.git ip/<ip_block>
 ```
 
 Using relative URLs will make sure the submodule is pulled using the correct method (HTTPS/SSH).

xschem/xschemrc

@@ -24,7 +24,7 @@ if {![info exists PDK]} {
 append XSCHEM_LIBRARY_PATH :[file dirname [info script]]
 
 # Source the dependencies xschemrc files
-foreach rcfile [glob -nocomplain ../deps/*/xschem/xschemrc] {
+foreach rcfile [glob -nocomplain ../ip/*/xschem/xschemrc] {
   puts "sourcing $rcfile"
   source $rcfile
 }