Initial work for Pouetpouet board

Based on keyseebee but now very different.

1 files changed, 38 insertions, 26 deletions

diff --git a/README.md b/README.md
index 4e6eab1..1a1e20b 100644
--- a/README.md
+++ b/README.md
@@ -1,35 +1,47 @@
-# KeySeeBee
-
-![KeySeeBee](images/keyseebee.jpg)
-
-KeySeeBee is a split ergo keyboard. It is only 2 PCB (so the name)
-with (almost) only SMD components on it. It's only a keyboard, no LED,
-no display, nothing more than keys and USB.
+# PouetPouet
 
 The firmware is [Keyberon](https://github.com/TeXitoi/keyberon), a
 pure rust firmware.
 
 ## Features
 
- * 44 keys, using Cherry MX or Kailh choc switches, only 1U keycaps;
- * USB-C connector on the 2 sides;
- * TRRS cable for connecting the 2 halves (for power and UART communication between the 2 halves);
- * 2 STM32F072 MCU, with hardware USB DFU bootloader and crystal less USB;
- * Only onboard SMD component (except for the switches and TRRS connector).
+ * 60 keys, using Cherry MX switches, only 1U keycaps;
+ * USB-C connector;
+ * 1 STM32F072 MCU, with hardware USB DFU bootloader;
+ * Only onboard SMD component (except for the switches).
 
 ## Inspiration
 
- * [Plaid](https://github.com/hsgw/plaid) for "show the components"
- * [GergoPlex](https://www.gboards.ca/product/gergoplex) for "just a keyboard" and "only a PCB with SMD components"
- * [Lily58](https://github.com/kata0510/Lily58) for the thumb cluster
- * [Kyria](https://blog.splitkb.com/blog/introducing-the-kyria) for
-   "don't be affraid of pinky stagger"
-
-## Gallery
-
-![From above with one side upside down](images/above-with-back.jpg)
-
-![Side view](images/side-view.jpg)
+ * [Keyseebee](https://github.com/TeXitoi/keyseebee) for being the «I will change it quickly and have something ready in an hour» base project (even if I ended up redoing most of the hardware design).
+ * [Steamvan](https://github.com/jmdaly/steamvan) for some KiCad design ideas;
+ * [help-14](https://github.com/help-14/mechanical-keyboard) for making a nice list of existing keyboard;
+ * [Masterzen](http://www.masterzen.fr/2020/05/03/designing-a-keyboard-part-1/) and many others for writing online tutorials for newbies like me.
+
+## Usefull resources
+ * [Mechanical Keyboard](https://github.com/help-14/mechanical-keyboard) is a list of DIY keyboards
+ * [Awesome Mechanical Keyboard](https://github.com/BenRoe/awesome-mechanical-keyboard) is another [https://github.com/topics/awesome](«awesome») list
+
+## Bill Of Materials
+
+|Item                                                                      |Package|Qty|Remarks                                |Price |
+|--------------------------------------------------------------------------|-------|--:|---------------------------------------|-----:|
+| PCB                                                                      |       | 3 | aisler                                |      |
+| 100 nF                                                                   | 0805  | 5 | magic match aisler                    | 0    |
+| PRTR5V0U2X,215                                                           | sot-143| 1 |                                      | 0.43 |
+| 4.7 uF                                                                   | 0805  | 2 |                                       | 0    |
+| 470 Ohm                                                                  | 0805  | 1 | magic match aisler                    | 0    |
+| TLV70233DBVR                                                             | sot-23| 1 | magic match aisler                    | 0.37 |
+| 74LVC1G34GW,125                                                          |       | 1 | magic match aisler                    | 0.28 |
+| 0805L050WR (500mA Polyfuse)                                              | 0805  | 1 | magic match aisler                    | 1.91 |
+| RS282G05A3SMRT (micro switch)                                            |       | 2 | magic match aisler                    | 1.26 |
+| 100nF                                                                    | 0805  | 2 | magic match aisler                    | 0 |
+| 5.1 kOhm                                                                 | 0805  | 3 | magic match aisler                    | 0 |
+| 0805L050WR (500mA Polyfuse)                                              | 0805  | 1 | magic match aisler                    | 0 |
+| 1N4148WS-7-F                                                             | sod-323 | 60|                                     |   |
+| WS2812B                                                                  |       | 10|                                       |   |
+| USB TypeC HRO Receptacle                                                 |       | 1 |                                       |   |
+| Gateron Switch                                                           |       | 60|                                       |   |
+| Keycaps                                                                  |       | 60|                                       |   |
 
 ## Compiling and flashing
 
@@ -47,19 +59,19 @@ Compile:
 
 ```shell
 cd firmware
-cargo objcopy --bin keyseebee --release -- -O binary keyseebee.bin
+cargo objcopy --bin pouetpouet --release -- -O binary pouetpouet.bin
 ```
 
 To flash using dfu-util, first put the board in dfu mode by pressing
 BOOT, pressing and releasing RESET and releasing BOOT. Then:
 
 ```shell
-dfu-util -d 0483:df11 -a 0 -s 0x08000000:leave -D keyseebee.bin
+dfu-util -d 0483:df11 -a 0 -s 0x08000000:leave -D pouetpouet.bin
 ```
 
 The fist time, if the write fail, your flash might be protected. To
 unprotect:
 
 ```shell
-dfu-util -d 0483:df11 -a 0 -s 0x08000000:force:unprotect -D keyseebee.bin
+dfu-util -d 0483:df11 -a 0 -s 0x08000000:force:unprotect -D pouetpouet.bin
 ```