@tscircuit/footprinter 0.0.36 → 0.0.37

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +6 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -69,6 +69,12 @@ industry best practices or otherwise "reasonable" defaults. In theory, upgrading
69
69
  footprinter could cause the defaults to change, which is why sloppy definitions
70
70
  are generally not desirable.
71
71
 
72
+ ## Adding new footprint functions
73
+
74
+ You can add new footprint functions by introducing a new function in the [src/fn](https://github.com/tscircuit/footprinter/tree/main/src/fn)
75
+ directory. You'll also need to export it from the [footprint function index file](https://github.com/tscircuit/footprinter/blob/main/src/fn/index.ts)
76
+
77
+ After you've written the function, you can introduce a quick test, e.g. [soic.test.ts](https://github.com/tscircuit/footprinter/blob/main/tests/soic.test.ts)
72
78
  Currently it's not possible to see if a given definition is sloppy.
73
79
 
74
80
  An example of a sloppy definition is `bga64`. It's very underconstrained and
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@tscircuit/footprinter",
3
3
  "type": "module",
4
- "version": "0.0.36",
4
+ "version": "0.0.37",
5
5
  "description": "",
6
6
  "main": "dist/index.cjs",
7
7
  "files": [