diff --git a/README.md b/README.md deleted file mode 100644 index f07347d..0000000 --- a/README.md +++ /dev/null @@ -1,44 +0,0 @@ -# The Dactyl Keyboard -The Dactyl is a parameterized, split-hand, concave, columnar, ergonomic keyboard. - - - -There's a talk about the motivation and design of the Dactyl that helps provide context for this repo: - -[![IMAGE ALT TEXT HERE](https://img.youtube.com/vi/uk3A41U0iO4/0.jpg)](https://www.youtube.com/watch?v=uk3A41U0iO4) - -## Assembly - -### Generating a Design - -**Setting up the Clojure environment** -* [Install the Clojure runtime](https://clojure.org) -* [Install the Leiningen project manager](http://leiningen.org/) -* [Install OpenSCAD](http://www.openscad.org/) - -**Generating the design** -* Run `lein repl` -* Load the file `(load-file "src/dactyl_keyboard/dactyl.clj")` -* This will regenerate the `things/*.scad` files -* Use OpenSCAD to open a `.scad` file. -* Make changes to design, repeat `load-file`, OpenSCAD will watch for changes and rerender. -* When done, use OpenSCAD to export STL files - -**Tips** -* [Some other ways to evaluate the clojure design file](http://stackoverflow.com/a/28213489) -* [Example designing with clojure](http://adereth.github.io/blog/2014/04/09/3d-printing-with-clojure/) - - -### Printing -Pregenerated STL files are available in the [things/](things/) directory. - -### Wiring -Masks for the flexible PCBs I used are available for the [left](resources/pcb-left.svg) and [right](resources/pcb-right.svg) side. - -A [very rough guide for the brave is here](guide/README.org#wiring) - It will be improved over time (**TODO**)! - -## License - -Copyright © 2015 Matthew Adereth - -The source code for generating the models (everything excluding the [things/](things/) and [resources/](resources/) directories is distributed under the [GNU AFFERO GENERAL PUBLIC LICENSE Version 3](LICENSE). The generated models and PCB designs are distributed under the [Creative Commons Attribution-ShareAlike License Version 4.0](LICENSE-models). diff --git a/README.org b/README.org new file mode 100644 index 0000000..7227447 --- /dev/null +++ b/README.org @@ -0,0 +1,74 @@ +* Daktil Keyboard + +Daktil is a fork of [[https://github.com/adereth/dactyl-keyboard][the Dactyl]], a parameterized, split-hand, concave, columnar, ergonomic keyboard. +A number of them were built at [[http://ljudmila.org/][Ljudmila]], at the [[https://wiki.ljudmila.org/Tipkovnica_dactyl][PIFlab workshop]]. + +[[file:resources/keyboards.jpg]] + +There's a [[https://www.youtube.com/watch?v=uk3A41U0iO4][very interesting talk]] about the motivation and design of the original Dactyl by Matt Addereth, its creator: + +** Differences from the original design + +The generated model has not changed, but we used an Arudino ProMicro instead of a Teensy Arduino controller. We also did the wiring in columns instead of rows and connected the left and right parts with a spiral telephone cord with 4P4C connectors/cords. + +We built some original Dactyls and some [[https://github.com/tshort/dactyl-keyboard][Dactyl Manuforms]]. + +** Assembly + +*** Parts / materials + - Cherry MX switches + - Arduino Pro Micro (you can / we did / use a clone) + - IO expander (MCP23008) + - 3d print material + - 1N41 diodes (1 for each key / approx. 60) + - two 2,2 kΩ resistors + - two 4P4C telephone jacks and a spiral cord + - enameled wire + +*** Generating a Design + +*Setting up the Clojure environment* + +- [[https://clojure.org][Install the Clojure runtime]] +- [[http://leiningen.org/][Install the Leiningen project manager]] +- [[http://www.openscad.org/][Install OpenSCAD]] + +**Generating the design** +- Run `lein repl` +- Load the file `(load-file "src/dactyl_keyboard/dactyl.clj")` +- This will regenerate the `things/*.scad` files +- Use OpenSCAD to open a `.scad` file. +- Make changes to design, repeat `load-file`, OpenSCAD will watch for changes and rerender. +- When done, use OpenSCAD to export STL files + +**Tips** + +*Tips* +- [[http://stackoverflow.com/a/28213489][Some other ways to evaluate the clojure design file]] +- [[http://adereth.github.io/blog/2014/04/09/3d-printing-with-clojure/][Example designing with clojure]] + +*** Printing + +Pregenerated STL files are available in the [[things/][things]] directory. + +[[things/daktil_dlan_2.stl][Handrests]] prototyped at PIFcamp 2018 were designed with Blender. + +*** Wiring + +*TODO* + +*** Firmware setup + +*TODO* + +[[https://github.com/g1smo/qmk_firmware][Our QMK repo fork]] + +** Original documentation + +You can find scans of original documents we used in the [[doc/][doc]] folder. + +** License + +Copyright © 2015 Matthew Adereth + +The source code for generating the models (everything excluding the [[things/][things]] and [[resources/][resources]] directories is distributed under the [[LICENSE][GNU AFFERO GENERAL PUBLIC LICENSE Version 3]]. The generated models and PCB designs are distributed under the [[LICENSE-models][Creative Commons Attribution-ShareAlike License Version 4.0]]. diff --git a/doc/finger_plan.pdf b/doc/finger_plan.pdf new file mode 100644 index 0000000..5dc2839 Binary files /dev/null and b/doc/finger_plan.pdf differ diff --git a/doc/intro.md b/doc/intro.md deleted file mode 100644 index cfdc90a..0000000 --- a/doc/intro.md +++ /dev/null @@ -1,3 +0,0 @@ -# Introduction to dactyl-cave - -TODO: write [great documentation](http://jacobian.org/writing/great-documentation/what-to-write/) diff --git a/doc/manuform_guide.pdf b/doc/manuform_guide.pdf new file mode 100644 index 0000000..90d86b2 Binary files /dev/null and b/doc/manuform_guide.pdf differ diff --git a/doc/page_intentionally_blank.pdf b/doc/page_intentionally_blank.pdf new file mode 100644 index 0000000..6ea8bea Binary files /dev/null and b/doc/page_intentionally_blank.pdf differ diff --git a/doc/pro_micro_large.pdf b/doc/pro_micro_large.pdf new file mode 100644 index 0000000..16155b6 Binary files /dev/null and b/doc/pro_micro_large.pdf differ diff --git a/doc/pro_micro_masterguide.pdf b/doc/pro_micro_masterguide.pdf new file mode 100644 index 0000000..5168349 Binary files /dev/null and b/doc/pro_micro_masterguide.pdf differ diff --git a/doc/teensy_io.pdf b/doc/teensy_io.pdf new file mode 100644 index 0000000..eb2b220 Binary files /dev/null and b/doc/teensy_io.pdf differ diff --git a/doc/test_sheet.pdf b/doc/test_sheet.pdf new file mode 100644 index 0000000..0a2ac2d Binary files /dev/null and b/doc/test_sheet.pdf differ diff --git a/doc/thumb_plan.pdf b/doc/thumb_plan.pdf new file mode 100644 index 0000000..be93b1a Binary files /dev/null and b/doc/thumb_plan.pdf differ diff --git a/doc/thumb_plan_left.pdf b/doc/thumb_plan_left.pdf new file mode 100644 index 0000000..149087e Binary files /dev/null and b/doc/thumb_plan_left.pdf differ diff --git a/doc/thumb_plan_mac.pdf b/doc/thumb_plan_mac.pdf new file mode 100644 index 0000000..142baed Binary files /dev/null and b/doc/thumb_plan_mac.pdf differ diff --git a/doc/thumb_plan_right.pdf b/doc/thumb_plan_right.pdf new file mode 100644 index 0000000..9a34620 Binary files /dev/null and b/doc/thumb_plan_right.pdf differ diff --git a/resources/glamourshot.png b/resources/glamourshot.png deleted file mode 100755 index 751346b..0000000 Binary files a/resources/glamourshot.png and /dev/null differ diff --git a/resources/keyboards.jpg b/resources/keyboards.jpg new file mode 100644 index 0000000..a2f08fd Binary files /dev/null and b/resources/keyboards.jpg differ diff --git a/resources/pcb-left.svg b/resources/pcb-left.svg deleted file mode 100755 index f8efb00..0000000 --- a/resources/pcb-left.svg +++ /dev/null @@ -1,4150 +0,0 @@ - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 0 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 3 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 2 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1 - - - - - - - - - - - - - - 4 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Col 1 - - Col 4 - - Col 3 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 2 - - - - - - - - - - - - - - - - - - diff --git a/resources/pcb-right.svg b/resources/pcb-right.svg deleted file mode 100755 index b8e748c..0000000 --- a/resources/pcb-right.svg +++ /dev/null @@ -1,3518 +0,0 @@ - - - - - - - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - 0 - - - - - - - - - - - - - - - 1 - - - - - - - - - - - - - - - 2 - - - - - - - - - - - - - - - 3 - - - - - - - - - - - - - 4 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/resources/prototype.jpg b/resources/prototype.jpg deleted file mode 100644 index fb1c0fd..0000000 Binary files a/resources/prototype.jpg and /dev/null differ diff --git a/things/daktil_dlan.blend b/things/daktil_dlan.blend new file mode 100644 index 0000000..527a7ab Binary files /dev/null and b/things/daktil_dlan.blend differ diff --git a/things/daktil_dlan_2.stl b/things/daktil_dlan_2.stl new file mode 100644 index 0000000..23a0a68 Binary files /dev/null and b/things/daktil_dlan_2.stl differ