https://github.com/gowhale/go-circuit-diagram

Using go to create circuit diagram images
https://github.com/gowhale/go-circuit-diagram

Last synced: about 1 month ago
JSON representation

Using go to create circuit diagram images

• Host: GitHub
• URL: https://github.com/gowhale/go-circuit-diagram
• Owner: gowhale
• Created: 2022-12-29T17:53:15.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-14T03:08:31.000Z (about 2 years ago)
• Last Synced: 2024-11-17T00:33:49.920Z (3 months ago)
• Language: Go
• Size: 68.4 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# 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: 

![image](https://user-images.githubusercontent.com/32711718/210115656-835318be-bd8f-4699-ba2f-fde8f409bf74.png)

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:

![image](https://user-images.githubusercontent.com/32711718/210153278-a90e97a5-0527-4db2-8e4c-f0a49eacb67d.png)

## Actions created by this template:

### Testing

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

![example event parameter](https://github.com/gowhale/go-circuit-diagram/actions/workflows/pkg-cov.yml/badge.svg?event=push)

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

![example event parameter](https://github.com/gowhale/go-circuit-diagram/actions/workflows/pages.yml/badge.svg?event=push)

### Linters

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

![example event parameter](https://github.com/gowhale/go-circuit-diagram/actions/workflows/revive.yml/badge.svg?event=push)

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

![example event parameter](https://github.com/gowhale/go-circuit-diagram/actions/workflows/golangci-lint.yml/badge.svg?event=push)

### Project Management

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

![example event parameter](https://github.com/gowhale/go-circuit-diagram/actions/workflows/issue.yml/badge.svg?event=push)

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

![example event parameter](https://github.com/gowhale/go-circuit-diagram/actions/workflows/cut-release.yml/badge.svg?event=push)