Code Monkey home page Code Monkey logo

plotkicadsch's Introduction

Build StatusBuild status

Kicad schematic plotter

PlotKicadsch is a small tool to export Kicad Sch files to SVG pictures. In the future, export to other formats may be available (PDF, PNG).

This package also provides the plotgitsch command which allows to visually compare git revisions of schematics:

Visual diff

For more information type plotgitsch --help.

Objectives

This project is mainly an attempt at using ocaml with functional programing on a pet real-world project.

The quality of the output is not a first requirement (meaning: not supposed to match Kicad one to one), but the accuracy of positioning matters.

Installation

Stable version from OPAM

The stable version of plotkicadsch can be installed with opam:

$ opam switch 4.06.0
$ eval `opam config env`
$ opam update
$ opam install plotkicadsch

If you don't use opam consult the .opam files for build instructions.

Windows

For Windows users, there is an experimental opam repository which works pretty well.

Alternatively, you can simply grab precompiled binaries at

https://github.com/jnavila/plotkicadsch/releases

If you have installed git for windows, chances are that you have installed the bash environment, so drop the binaries in C:\Program Files\Git\mingw64\bin(Administrator rights required). They should be accessible on your bash command line and work just like under Linux/OSX.

Master version

The latest running version can also be installed from this repo by pinning the project in opam:

$ opam pin add kicadsch .
$ opam pin add plotkicadsch .
$ opam update
$ opam install plotkicadsch

How to

Using

All the commands have a help option. For plotgitsch, a small hands on guide is available.

Contributing

This project accepts GitHub pull requests, but as it is a self-teaching project, I would prefer to do all the core stuff. If you see some parts of the code whose style is not ocamlish or not FP ready, please let me know.

If this project happens to be of any use, let me know also!

plotkicadsch's People

Contributors

jnavila avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.