@tscircuit/footprinter 0.0.1

package/README.md

@@ -0,0 +1,45 @@
+# @tscircuit/footprinter
+
+Footprinter is tscircuit's DSL and micro-builder for creating footprints
+
+You can create very custom footprints using the `<footprint>` element, but the
+compressability is poor. `footprinter` produces very short, low parameter
+mini-programs for generating footprints, this makes it suitable for standardized
+footprints.
+
+Here are some example programs:
+
+```ts
+import { fp } from "@tscircuit/footprinter"
+
+fp.cap().w(0.4).h(0.2)
+fp.cap().p(0.1).pw(0.1).ph(0.1) // pitch, pad width and pad height
+fp.cap().metric("0402")
+fp.res().imperial("01005")
+fp.dip(4).w(7.62)
+fp.dip(4).w(7.62).socket()
+```
+
+## Footprinter Strings
+
+A footprinter string is a string that maps to a set of builder calls.
+
+```ts
+import { fp } from "@tscircuit/footprinter"
+
+fp.string("dip4_w7.62") // same as fp.dip(4).w(7.62)
+fp.string("dip4_w7.62mm") // same as fp.dip(4).w(7.62)
+fp.string("dip4_w0.3in") // same as fp.dip(4).w("0.3in")
+```
+
+## Magic
+
+`footprinter` comes with a `fp.magic` function which calls a remote server that
+attempts to convert the specified string into a `footprinter` string. This can
+help when you're looking at a random package designator from an online site. You
+should always confirm these footprints against the datasheet.
+
+## Generation Defaults
+
+- Pins are CCW starting at the top left
+- Y is upward-positive, X is rightward-positive

package/ava.config.js

@@ -0,0 +1,5 @@
+export default {
+  files: ["tests/**/*.test.ts"],
+  extensions: ["ts"],
+  require: ["esbuild-register"],
+}