dactyl-manuform-5-7/README.md

# The Dactyl Keyboard
The Dactyl is a parameterized, split-hand, concave, columnar, ergonomic keyboard.

<img src="https://raw.githubusercontent.com/adereth/dactyl-cave/master/resources/glamourshot.png"/>

## 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-NonCommercial-ShareAlike License Version 3.0](LICENSE-models).
Including PCBs and updating README 2015-12-04 05:39:36 +00:00			`# The Dactyl Keyboard`
			`The Dactyl is a parameterized, split-hand, concave, columnar, ergonomic keyboard.`
Adding license 2015-03-06 23:25:36 +00:00
Including PCBs and updating README 2015-12-04 05:39:36 +00:00			`<img src="https://raw.githubusercontent.com/adereth/dactyl-cave/master/resources/glamourshot.png"/>`
Adding license 2015-03-06 23:25:36 +00:00
Adding link to model from README 2015-03-13 23:31:09 +00:00			`## Assembly`
Adding license 2015-03-06 23:25:36 +00:00
Adding link to model from README 2015-03-13 23:31:09 +00:00			`### Generating a Design`
added to section Generating a Design 2016-08-16 18:48:20 +00:00
			`Setting up the Clojure environment`
downloading is implied 2016-08-16 18:51:48 +00:00			`* [Install the Clojure runtime](https://clojure.org)`
			`* [Install the Leiningen project manager](http://leiningen.org/)`
			`* [Install OpenSCAD](http://www.openscad.org/)`
added to section Generating a Design 2016-08-16 18:48:20 +00:00
			`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`
had my links backwards 2016-08-16 18:50:33 +00:00			`* [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/)`
added to section Generating a Design 2016-08-16 18:48:20 +00:00
Adding link to model from README 2015-03-13 23:31:09 +00:00
			`### Printing`
Including PCBs and updating README 2015-12-04 05:39:36 +00:00			`Pregenerated STL files are available in the [things/](things/) directory.`
Adding link to model from README 2015-03-13 23:31:09 +00:00
			`### Wiring`
Including PCBs and updating README 2015-12-04 05:39:36 +00:00			`Masks for the flexible PCBs I used are available for the [left](resources/pcb-left.svg) and [right](resources/pcb-right.svg) side.`
Adding license 2015-03-06 23:25:36 +00:00
Update link to README.org for wiring 2016-10-10 18:24:29 +00:00			`A [very rough guide for the brave is here](guide/README.org#wiring) - It will be improved over time (TODO)!`
Adding license 2015-03-06 23:25:36 +00:00
Including PCBs and updating README 2015-12-04 05:39:36 +00:00			`## License`
Add very rough guide 2015-12-10 03:16:51 +00:00
Including PCBs and updating README 2015-12-04 05:39:36 +00:00			`Copyright © 2015 Matthew Adereth`
Adding license 2015-03-06 23:25:36 +00:00
Including PCBs and updating README 2015-12-04 05:39:36 +00:00			`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-NonCommercial-ShareAlike License Version 3.0](LICENSE-models).`