]> git.donarmstrong.com Git - qmk_firmware.git/commitdiff
Updated frenchdev readme
authornpoirey <nicolas.poirey@gmail.com>
Fri, 23 Jun 2017 21:59:30 +0000 (23:59 +0200)
committernpoirey <nicolas.poirey@gmail.com>
Fri, 23 Jun 2017 21:59:30 +0000 (23:59 +0200)
keyboards/handwired/frenchdev/readme.md

index 47e4ade16c2d6f5fcdaf4de5ea12b00a7ebfe454..698b4befb29deb6410cf8f8b10161abc447e73e4 100644 (file)
@@ -1,18 +1,55 @@
-# My take on a splitted keyboard
+# Frenchdev : My take on a splitted keyboard for dev and french language
+Concept based on
+ - [ergodox](https://ergodox-ez.com/)
+ - [katy](https://deskthority.net/workshop-f7/katy-keyboard-or-k80cs-key80-contoured-split-t8524.html)
 
-default layout :
-[default layout](http://i.imgur.com/r2Nvr4p.png)
+with the added possibility to connect up to 6 external switches like pedals,
+ and somewhat like the katy, not all keys are on the same level for easier reach.
 
-the thing when finished : 
-http://imgur.com/a/6FY8v
+###Photos
+- [default layout](http://i.imgur.com/r2Nvr4p.png)
+- [editable layout on keyboard layout editor](http://www.keyboard-layout-editor.com/#/gists/4480e3ab8026eb7c710a7e22203ef4aa) (keys placement is NOT precise on this)
+- [the thing when finished](http://imgur.com/a/6FY8v) 
+- [concept and cardboard mockup](http://imgur.com/a/R0vvs)
 
-concept and mockup:
-http://imgur.com/a/R0vvs
-
-to build :
+##Build instructions
 
     docker run --rm -e keymap=default -e keyboard=frenchdev --rm -v D:/Repositories/qmk:/qmk:rw edasque/qmk_firmware
     
+##Laser-cuttable file
+There is intentionnaly no hole for the TRRS connector, you are supposed to use a drill for it. 
+This way if you don't want to use the pedals you don't have a useless hole. Plus it's cleaner.
+http://qmk.fm/frenchdev/frenchdev_v1_lasercut_template.svg
+
+##Side stickers
+You can find my original file here : http://qmk.fm/frenchdev/example_printable_stickers.svg
+
+I used it when training but now I use blanks and the layout is different. 
+I still uploaded it because I think it can be a good jumpstart for any temporary stickers on the 
+side of keycaps.
+
+##List of parts
+- I2C mcp23018
+- [teensy 2](https://www.pjrc.com/store/teensy.html)
+- 3 LED, 5mm tall with flat head
+- 3 330 ohm resistor
+- 2 470 ohm resistor
+- 2 TRRS connectors
+- 1 [micro usb breakout board](http://www.ebay.com/itm/-/201387922085?)
+- 88 cherry/gateron switchs
+- 94 4148 diodes
+- 34 R4 keys
+- 14 R3 keys
+- 20 R2 keys
+- 22 R1 keys
+
+if you fancy adding pedals :
+[these are good enough and cheap](https://www.amazon.fr/gp/product/B00V7WITKI/ref=oh_aui_detailpage_o04_s00?ie=UTF8&psc=1). You also need a RCA connector for each of those to replace the included cable
+
+If you (or your coworkers) find them too loud you can replace the switch inside them. 
+For once we don't really care about what's inside :) 
+
+##Various indications
 
 The PHYSICAL rows and columns are connected as such :
 
@@ -57,8 +94,9 @@ and on left hand (main) :
            | E6           GND |
            `------------------'
 
-we use pull up resistor for SCL et VDA, see https://github.com/ErgoDox-EZ/docs/blob/master/ErgoDox%20EZ%20Schematic.pdf for example
+We use pull up resistor for SCL and VDA, see https://github.com/ErgoDox-EZ/docs/blob/master/ErgoDox%20EZ%20Schematic.pdf for example
 
 the connector is a standard TRRS (jack with audio + mic)
 
 Diode direction is row to column
+