@tscircuit/footprinter 0.0.35 → 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.
- package/README.md +8 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,7 +5,8 @@ Footprinter is tscircuit's DSL and micro-builder for creating footprints.
|
|
|
5
5
|
You can create very custom footprints using the `<footprint>` element, but the
|
|
6
6
|
compressability is poor. `footprinter` produces very short, low parameter
|
|
7
7
|
mini-programs for generating footprints, this makes it suitable for standardized
|
|
8
|
-
footprints.
|
|
8
|
+
footprints. You can use it with any component that accepts a footprint prop, e.g.
|
|
9
|
+
`<bug footprint="qfp12_p0.5" />`
|
|
9
10
|
|
|
10
11
|
Here are some example programs:
|
|
11
12
|
|
|
@@ -68,6 +69,12 @@ industry best practices or otherwise "reasonable" defaults. In theory, upgrading
|
|
|
68
69
|
footprinter could cause the defaults to change, which is why sloppy definitions
|
|
69
70
|
are generally not desirable.
|
|
70
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)
|
|
71
78
|
Currently it's not possible to see if a given definition is sloppy.
|
|
72
79
|
|
|
73
80
|
An example of a sloppy definition is `bga64`. It's very underconstrained and
|