create-rulecad 0.1.2 → 0.2.0

package/index.mjs

@@ -16,7 +16,7 @@ fs.renameSync(path.join(dir, 'gitignore'), path.join(dir, '.gitignore')); // npm
 const readme = path.join(dir, 'README.md');
 fs.writeFileSync(readme, fs.readFileSync(readme, 'utf8').replaceAll('NAME', name));
 // $RULECAD_LOCAL: a rulecad checkout to use instead of npm (to try unpublished changes)
-const from = (pkg) => (process.env.RULECAD_LOCAL ? `file:${path.join(path.resolve(process.env.RULECAD_LOCAL), 'packages', pkg)}` : '^0.1.0');
+const from = (pkg) => (process.env.RULECAD_LOCAL ? `file:${path.join(path.resolve(process.env.RULECAD_LOCAL), 'packages', pkg)}` : '^0.2.0');
 fs.writeFileSync(path.join(dir, 'package.json'), `${JSON.stringify({
   name, private: true, type: 'module',
   scripts: { check: 'cad check home/soap-tray' },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-rulecad",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "Start a rulecad project: npm create rulecad my-designs. A workspace with a soap tray to start from, ready to check, preview, export and share.",
   "type": "module",
   "bin": {

package/template/AGENTS.md

@@ -47,6 +47,18 @@ variable says which rule it comes from. Follow these steps; they're what makes a
   with ranges from rules. An overlap or gap outside its range is a finding: report it with the numbers, and never
   widen a range to make it pass without saying why.
 - Build bigger things from checked assemblies used as items, rather than placing their objects again.
+- A part is named in fits as `<item>.<part>`; an object that returns one unnamed shape has one part, `body`.
+- A gap fit can't tell whether holes line up. Where a board screws into a part, add a holes fit
+  (`{ "holes": "pcb.board", "into": "case.body", "depth": "m2.insert_length" }`).
+- A part built around another (a case around its board) reads it: `"uses": ["node/carrier"]`, then
+  `carrier.board_w` and `v.carrier.board_holes`. Never copy another object's numbers by hand.
+
+## Circuit boards
+- `"engine": "pcb"` in the .json; `main(v)` returns a board built with `v.pcb` (see @rulecad/pcb's README).
+- Parts come from rule sets where one exists (`v.pcb.xiao`, `qwiic`, `jstph`, `header`), or any standard footprint by
+  name (`v.pcb.part('U2', 'soic8', x, y)`). Turn parts in quarter turns with `rotation`, held in a variable.
+- Join pins with `nets` (`GND: ['U1.GND', 'J1.GND']`) and let the autorouter draw them; `cad check` runs the fab's
+  design rules. Look at the copper preview: connectors should face the edge their plug comes from.
 
 ## Talking to the person
 - Give links as one labelled line (`npx cad link <project>/<object> --md`), never a raw URL. If it says