Merge branch 'master' of gitlab.com:mkbd65/pcb

README.md

@@ -2,17 +2,26 @@
 
 # mkbd65 PCB
 
-KiCAD files for the PCB of mkbd65.
+These are the KiCAD files for mkbd65.
 
-`main` folder contains the main PCB. `connector` is the flat cable to connect to your phone.
+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.
 
-- [Octopart BOM][bom]
+Get the gerber files for the main PCB and your phones connector cable from the latest release:
-- [Interactive BOM][ibom]
-
-Get the gerber files from the latest release:
 
 - [main rev0][main_rev0]
-- connector rev0 (TBA)
+- connector oneplus 8t rev0 (TBA)
+
+__IMPORTANT__: When ordering the main PCB make sure that the PCB thickness is set to 1mm. This is needed so that the PCB fits into the case.
+
+Ordering 5 PCBs with a PCB fab like [JLCPCB](https://jlcpcb.com/) will cost around ~7€ + ~5€ shipping to Germany. If you want golden ENIG finsh and a nice purple color you will end up with ~25€. You can check the cost of the other components with the [Octopart BOM][octopart].
+
+_TIP: If you can't find the ATMEGA32, you can sample it directly from Microchip. 😉_
+
+A stencil to make it easier to apply solder paste can be ordered for ~6€. You can then solder components with a [hot air gun](https://duckduckgo.com/?q=hot+air+gun+soldering&t=h_&iar=images&iax=images&ia=images) or a [reflow oven](https://duckduckgo.com/?q=reflow+oven&t=h_&iax=images&ia=images).
+
+I soldered my own board with a T-962 reflow oven with [custom firmware](https://github.com/UnifiedEngineering/T-962-improvements).
+
+Using the [Interactive BOM][ibom] makes it easy to place components once you got your PCBs.
 
 ## Firmware
 
@@ -22,16 +31,19 @@ Get the gerber files from the latest release:
    ```
 2. Checkout the `mkbd65` branch
    ```
-   cd mkbd65
+   cd qmk-firmware
    git checkout mkbd65
    ```
-3. Install qmk tool
+3. Install [qmk tool](https://docs.qmk.fm/#/cli)
    ```shell
-   # arch linux
+   # Arch Linux
    sudo pacman -S qmk
-   # others
+   # Other Linux
-   python3 -m pip install --user qmk
+   pip install --user qmk
+   # macOS
+   brew install qmk/qmk/qmk
    ```
+   Windows: https://msys.qmk.fm/
 4. Setup qmk environment
    ```shell
    qmk setup
@@ -41,7 +53,7 @@ Get the gerber files from the latest release:
    qmk flash -kb mkbd65 -km ansi
    ```
 
-You can find the code for the keyboard [here](https://gitlab.com/mkbd65/qmk-firmware/-/tree/mkbd65/keyboards/mkbd65).
+You can find the source code for the keyboard under [keyboards/mkbd65](https://gitlab.com/mkbd65/qmk-firmware/-/tree/mkbd65/keyboards/mkbd65) in the repo.
 
 ## Case
 
@@ -54,7 +66,8 @@ Follow the instructions to build it for your phone.
 ![powered by QMK](badge-dark.svg)
 
 
-[bom]: https://octopart.com/bom-tool/YlMBpo3w
+[octopart]: https://octopart.com/bom-tool/YlMBpo3w
 [ibom]: https://gitlab.com/mkbd65/pcb/-/raw/master/main/bom/ibom.html?inline=false
 [main_rev0]: https://gitlab.com/mkbd65/pcb/-/releases/main_rev0
-[connector_rev0]: https://gitlab.com/mkbd65/pcb/-/releases/connector_rev0
+[connector_oneplus_8t_rev0]: https://gitlab.com/mkbd65/pcb/-/releases/connector_oneplus_8t_rev0
+[qmk_toolbox]: https://github.com/qmk/qmk_toolbox