diff --git a/README.md b/README.md index 7dcac6d..06d328d 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,19 @@ +# mkbd65 PCB + +This repository contains the KiCAD files for the main PCB of mkbd65. You'll also need a connector cable that is +compatible with your phone and a case to fully assemble mkbd65. Follow the build guide at https://mkbd65.xengi.de for +build instructions. + +--- + +**old readme** + # mkbd65 PCB -These are the KiCAD files for mkbd65. +These are the KiCAD files for the main PCB. There is also a flat cable PCB you'll need to fully assemble mkbd65. The `main` folder contains the main PCB which holds all components. The `connector` folder contains the flat cables to connect to your phone. You have to build/order the correct one for your phone. If your phone is not supported open a ticket [here](https://gitlab.com/mkbd65/case/-/issues/new?issue#) with the `Add phone` template to get it on the list.