Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
seveibar committed Jun 12, 2024
1 parent 0093ea5 commit b942818
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,22 @@ const jsonSoup = await parseKicadModToTscircuitSoup(fileContent)
*/
```

You can also output "kicad json", an intermediary JSON format that more closely resembles the origina kicad sexpr.

```ts
import { parseKicadModToKicadJson } from "kicad-mod-converter"


const kicadJson = parseKicadModToKicadJson(readFileSync("SW_SP3T_PCM13.kicad_mod"))
/*
* {
* footprint_name: "...",
* fp_lines: [
* { start: [0, 0], end: [20, 4], stroke: { width: 0.1 } }
* ...
*/
```

## CLI Usage

```bash
Expand Down

0 comments on commit b942818

Please sign in to comment.