dactyl-manuform/README.md

# Dactyl ManuForm Keyboard

This is a fork of the [Dactyl-ManuForm](https://github.com/tshort/dactyl-keyboard). The Dactyl-Manuform is a fork of the [Dactyl](https://github.com/adereth/dactyl-keyboard) with the thumb cluster from [ManuForm](https://github.com/jeffgran/ManuForm). Some features from the Dactyl Manuform Mini are kept along with new features added. 

## Features

- The use of sidenubs can be disabled. Sidenub should be disabled if you use Kailh, and Outemu. If you use Cherry MX, Gateron or Zealios switches, you can enable the sidenubs.
- Toggle for outer column between using 1.5u sized keys and 1u sized keys.
- If enabled, the rows which use 1.5u sized keys can be specified.
- Toggle for an extra row of keys for the outer column(s).
- Toggle for an extra inner column before the thumbcluster with (nrows-2) rows.
- Toggle between using the default thumb cluster, the mini thumb cluster designed by [l4u](https://github.com/l4u/dactyl-manuform-mini-keyboard), and a new thumb cluster.
- This new thumb cluster uses the same keycaps as the default, but is more compact. The thumb only has to move one position left or right from its neutral position to reach all the keys. 
- Removable controller board / TRRS jack holder as a separate part. This holder is then friction fit into a cutout on the back wall of the case. Designed for common TRRS breakout boards. 
- Models for both pro-micro and elite-c holders in the [things/](things/) directory. 

## Generate OpenSCAD and STL models

* Run `lein generate` or `lein auto generate`
* 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


## License

Copyright © 2015-2018 Matthew Adereth, Tom Short and Leo Lou

The source code for generating the models is distributed under the [GNU AFFERO GENERAL PUBLIC LICENSE Version 3](LICENSE).

The generated models are distributed under the [Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)](LICENSE-models).
Update README.md 2020-01-13 18:10:29 +08:00			`# Dactyl ManuForm Keyboard`
Adding license 2015-03-07 07:25:36 +08:00
Update README.md 2020-01-13 18:23:47 +08:00			`This is a fork of the [Dactyl-ManuForm](https://github.com/tshort/dactyl-keyboard). The Dactyl-Manuform is a fork of the [Dactyl](https://github.com/adereth/dactyl-keyboard) with the thumb cluster from [ManuForm](https://github.com/jeffgran/ManuForm). Some features from the Dactyl Manuform Mini are kept along with new features added.`
Add image of first print 2017-03-12 05:20:21 +08:00
Update readme 2018-04-21 10:07:41 +08:00			`## Features`

Update README 2018-06-23 17:19:36 +08:00			`- The use of sidenubs can be disabled. Sidenub should be disabled if you use Kailh, and Outemu. If you use Cherry MX, Gateron or Zealios switches, you can enable the sidenubs.`
Update README.md Specify new features for this fork. 2020-01-13 18:08:59 +08:00			`- Toggle for outer column between using 1.5u sized keys and 1u sized keys.`
			`- If enabled, the rows which use 1.5u sized keys can be specified.`
			`- Toggle for an extra row of keys for the outer column(s).`
			`- Toggle for an extra inner column before the thumbcluster with (nrows-2) rows.`
Update README.md 2020-04-21 07:08:08 +08:00			`- Toggle between using the default thumb cluster, the mini thumb cluster designed by [l4u](https://github.com/l4u/dactyl-manuform-mini-keyboard), and a new thumb cluster.`
Update README.md 2020-04-21 07:08:24 +08:00			`- This new thumb cluster uses the same keycaps as the default, but is more compact. The thumb only has to move one position left or right from its neutral position to reach all the keys.`
Update README.md Specify new features for this fork. 2020-01-13 18:08:59 +08:00			`- Removable controller board / TRRS jack holder as a separate part. This holder is then friction fit into a cutout on the back wall of the case. Designed for common TRRS breakout boards.`
Update README.md 2020-01-13 18:13:16 +08:00			`- Models for both pro-micro and elite-c holders in the [things/](things/) directory.`
Update readme 2018-04-21 10:07:41 +08:00
Update README.md 2019-11-04 23:44:49 +08:00			`## Generate OpenSCAD and STL models`
Readme updates and file reorg 2017-03-10 08:46:15 +08:00
Update license and remove extra resources 2018-04-21 07:12:31 +08:00			* Run `lein generate` or `lein auto generate`
added to section Generating a Design 2016-08-17 02:48:20 +08:00			* 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`

Add shapeways link 2018-05-11 09:01:29 +08:00
Update README 2018-04-22 09:13:28 +08:00
Including PCBs and updating README 2015-12-04 13:39:36 +08:00			`## License`
Add very rough guide 2015-12-10 11:16:51 +08:00
Update license and remove extra resources 2018-04-21 07:12:31 +08:00			`Copyright © 2015-2018 Matthew Adereth, Tom Short and Leo Lou`

Remove legacy files 2018-04-21 09:43:30 +08:00			`The source code for generating the models is distributed under the [GNU AFFERO GENERAL PUBLIC LICENSE Version 3](LICENSE).`
Adding license 2015-03-07 07:25:36 +08:00
Update license and remove extra resources 2018-04-21 07:12:31 +08:00			`The generated models are distributed under the [Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)](LICENSE-models).`