Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 

README.md

PinConnect Documentation

PinConnect turns a photo of a PCB into an interactive pinout diagram you can publish on a documentation site. It has three tools used in sequence: a visual designer, an HTML generator, and a Markdown embed extension.

Start with Getting Started for a quick run through the whole pipeline, then read Concepts to understand how the pieces fit together.

Contents

Overview

  • Getting Started: from board photo to embedded pinout, end to end.
  • Concepts: the pipeline and the two kinds of TOML file.

pinout-design

  • pinout-design: run the visual designer and build a board config.

pinout-gen

pinout-embed