@tscircuit/footprinter 0.0.31 → 0.0.32
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 +9 -8
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,19 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
Footprinter is tscircuit's DSL and micro-builder for creating footprints.
|
|
4
4
|
|
|
5
|
-
> Footprinter is the DSL that [text-to-footprint](https://github.com/tscircuit/text-to-footprint) uses.
|
|
6
|
-
> If you're unable to generate a particular footprint, try to see if you can produce it in footprinter.
|
|
7
|
-
> If you can't, you'll need to add some kind of representation in the DSL before it can be generated.
|
|
8
|
-
|
|
9
5
|
You can create very custom footprints using the `<footprint>` element, but the
|
|
10
6
|
compressability is poor. `footprinter` produces very short, low parameter
|
|
11
7
|
mini-programs for generating footprints, this makes it suitable for standardized
|
|
12
8
|
footprints.
|
|
13
9
|
|
|
14
|
-
> [INFO]
|
|
15
|
-
> Compressability of the DSL is important because it allows an LLM to fit more examples into context,
|
|
16
|
-
> and not waste output tokens on verbose elements
|
|
17
|
-
|
|
18
10
|
Here are some example programs:
|
|
19
11
|
|
|
20
12
|
```ts
|
|
@@ -28,6 +20,15 @@ fp.dip(4).w(7.62)
|
|
|
28
20
|
fp.dip(4).w(7.62).socket()
|
|
29
21
|
```
|
|
30
22
|
|
|
23
|
+
> [!NOTE]
|
|
24
|
+
> Footprinter is the DSL that [text-to-footprint](https://github.com/tscircuit/text-to-footprint) uses.
|
|
25
|
+
> If you're unable to generate a particular footprint, try to see if you can produce it in footprinter.
|
|
26
|
+
> If you can't, you'll need to add some kind of representation in the DSL before it can be generated.
|
|
27
|
+
|
|
28
|
+
> [!NOTE]
|
|
29
|
+
> Compressability of the DSL is important because it allows an LLM to fit more examples into context,
|
|
30
|
+
> and not waste output tokens on verbose elements
|
|
31
|
+
|
|
31
32
|
## Footprinter Strings
|
|
32
33
|
|
|
33
34
|
A footprinter string is a string that maps to a set of builder calls.
|