go-circuit-diagram

A repo to create circuit diagrams!

Summary

So far I the main prog creates a a PNG of an LED which you can find in the images folder.

It also creates a board with multiple LED's painted onto it which you can find in the images folder.

Examples:

The code in 'main.go' generates the following diagram. Showing how LED's, GPIO pins, wires and connectors can be added:

The code in './cmd/anode-matrix/main.go' generates the following diagram. Showing how an LED matrix can be created using custom rows and cols:

Actions created by this template:

Testing

The pkg-cov workflow runs all go tests and ensures pkg coverage is above 80%.

The pages workflow publishes a test coverage website everytime there is a push to the main branch. The website can be found here: https://gowhale.github.io/go-circuit-diagram/#file0

Linters

The revive workflow is executed to statically analsye go files: https://github.com/mgechev/revive

The golangci-lint workflow runs the golangci-lint linter: https://github.com/golangci/golangci-lint

Project Management

The issue workflow adds a new issue to the projects Kanban board:

The cut release workflow creates a binary executable everytime a release is published. The binary file is attached to the release.