Skip to main content

PCB Guide 1 - Introduction

This guide is intended as a direct replacement for the aging Ruiqi Mao's guide.
Credits go to that guide for serving as a base for this writeup.

So you want to design keyboard PCBs, or to make sure that you are doing things correctly.
We will build a similar 2x2 macropad in this introduction, but will do so in a more future-proof way compared to the other guides.

 

IN PROGRESS
This text will be removed once this page is complete.
Otherwise, please have much caution trusting any info on this page.

Step 1. Grab the requirements

We will be using KiCad for making the PCB.

Grab the program here:
http://kicad-pcb.org/download/
As of the time of writing this guide, the latest update is 5.0.2.

Now comes the download and install process. Grab a cup of coffee, for KiCad 5.0.2 is a whopping 1GB. 
Install as you would any other program.

Also, this guide will be using Git/GitHub to manage progress.
If you are new to this, grab GitHub desktop here:
https://desktop.github.com/
Install, then sign in or create an account as necessary.

If you already work with git, use whichever implementation you prefer, and replace all mentions of GitHub in this guide with your preferred methods.

Step 2. Repository Preparations

First, let's create a git repository for the PCB on GitHub
It is always nice to be able to roll things back in case things get out of hand.
Also, it is a simple and reliable way of sharing your work to the world.

Select File -> New repository,


Then create a repository.

Some of the important options:

  • Name - The name of the project. For now, use something like keyboard-pcb-tutorial and whatnot.
  • Description - Something so that viewers won't be completely confused as to what the repository is about.
  • Readme - The "front page of the repository" that's displayed when people access it on GitHub. May as well generate a blank one.
  • License - Places limits on what people can do with your project. For example, you can block commercial use, force derivatives to open-source as well, etc.

This will create a blank repository to begin work in.

Publish the repository,

Using whatever settings you prefer.
Uncheck "Keep this code private" if you want to have the data public and open-source to begin with.

Back to top