README.md
CherryShield


  
This project references ]]>this]]> guide from sparkfun


This repository is meant to create a prototype using ]]>cherry-mx switches]]> including necessary concepts such as designing a key matrix and leveraging properties of a general purpose diode.

This project is dependent on Sparkfun's EAGLE libraries and also OSHPark's DRU file. The EAGLE library is necessary because we use an already made cherry-mx switch footprint.

Get EAGLE

The EAGLE download can be found [here](]]>https://www.autodesk.com/products]]> EAGLE/free-download). The free version is sufficient in this case


  
EAGLE used to be made by CADSOFT USA, but is now under the AutoDesk umbrella.


Download and apply design rules

We are going to be using ]]>OSHPark's design rules]]> since this is the service we are using to make the PCBs

Clone the repository

For the puposes of simplicity, it is recommended that you clone this repository in your $HOME (root) directory. Input the following command in terminal.

git clone git@github.com:upinblayze/CherryShield.git

Download Sparkfun's EAGLE libraries

They are made for older versions of EAGLE, but they work nonetheless. You may either clone the [repository](]]>https://github.com/sparkfun/SparkFun]]> EAGLE-Libraries) or download the [zip file]( ]]>https://github.com/sparkfun/SparkFun]]> EAGLE-Libraries/archive/master.zip)

Setup EAGLE Directories


Options > Directories...


To add a paths by placing colons between each file path to where a the desired directory exists

To add the Sparkfun EAGLE libraries in the library field, append :path/to/SparkFun EAGLE-Libraries-master. In my case, since I have it in the root directory, I would append :$HOME/SparkFun EAGLE-Libraries-master
Repeat with the Project field. This is meant for if you do not have a project in the EAGLE created folder. I like to keep my git repositories in the root, so I would append :$HOME/CherryShield to the project field



  
You may want to add the DRU (design rules) directory here, however it may be more intuitive to simply use the design rules check to check against OSHPark design specifications


Open Project

From here you open the project and click on the schematics. You can view the board also by switching view via the SCH/BRD button in the tool bar