Skip to content

boardsource/solderable-keyboard-kit-build-guide-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 

Repository files navigation

Solderable keyboard kit build guide template

Rising tides raise all ships, so I wanted to make a good place for anyone to start a build guide. Take the photos listed below and you will have the photos needed for the build guide. Mvp do a find a replace for the items below and you should have something that works.

Find and replace tags:

  • KEYBOARDNAME
    • this is the keyboards name : string
  • QMKKEYBOARDNAME
    • keyboard path in qmk : string
  • KMKKEYBOARDNAME
    • keyboard path in qmk : string
  • KEYCAPSTYLE
    • this is the style of keycaps : string (choc, mx, choc or mx)
  • SOCKETSTYLE
    • this is the style of sockets : string (choc, mx, choc or mx)
  • SWITCHSTYLE
    • this is the style of switches : string (choc, mx, choc or mx)
  • DIODESTYLE
    • this is the style of diodes : string (through hole, SMD, SMD or TH)
  • CONTROLLERSTYLE
    • this is the style of controller : string (Pro-Micro style, seeed xiao, pico)
  • CONTROLLERPLACEMENT
    • this is the style of controller : string (face up, face down, face up on left face down in right side)
  • PCBCOUNT
    • this is the number of diodes : int
  • SWITCHCOUNT
    • this is the number of switches : int
  • CONTROLLERCOUNT
    • this is the number of controllers : int

Images needed:

  • NULLEDCOMPONETSIMAGE
    • url
  • DIODECLOSEUPIMG1
    • close up of diode orientation:url
  • DIODECLOSEUPIMG2
    • close up of diode half soldered:url
  • DIODECLOSEUPIMG3
    • diode finished:url
  • LEDORDERIMG
    • led order of image:url
  • LEDORIENTATIONIMG1
    • perkey:url
  • LEDORIENTATIONIMG2
    • underglow:url
  • LEDCLOSEUPIMG1
    • perkeypads soldered:url
  • LEDCLOSEUPIMG2
    • underglow pads soldered:url
  • LEDCLOSEUPIMG3
    • perkey placed:url
  • LEDCLOSEUPIMG4
    • underglow placed:url
  • LEDCLOSEUPIMG5
    • perkey finished:url
  • CONTROLLERCLOSEUPIMG1
    • header pins:url
  • CONTROLLERCLOSEUPIMG2
    • placed:url
  • CONTROLLERCLOSEUPIMG3
    • finished:url
  • OLEDCLOSEUPIMG1
    • placed:url
  • OLEDCLOSEUPIMG2
    • one pin soldered:url
  • OLEDCLOSEUPIMG3
    • finished:url
  • TRRSCLOSEUPIMG1
    • placed:url
  • TRRSCLOSEUPIMG2
    • finished:url
  • RESETCLOSEUPIMG1
    • one pin soldered:url
  • RESETCLOSEUPIMG2
    • finished:url
  • SOCKETCLOSEUPIMG1
    • one pad solder:url
  • SOCKETCLOSEUPIMG2
    • placed and reflowed:url
  • SOCKETCLOSEUPIMG3
    • finished:url

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published