dactyl-manuform/README.md

# Dactyl ManuForm Mini 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).

## Features

- Sidenub is disabled by default so that Kailh, Outemu and other switches can be
  used. If you use Cherry MX or Gateron switches, you can enable the sidenubs.
- One key in the thumb cluster has been removed. Other thumb keys are also adjusted.
- The total height is reduced and wire posts are removed. This results in a
  higher printing speed and a lower cost.
- A TRRS mount instead of a RJ9 mount is used.
- A micro USB mount is used. A breakout board, or an extension cable can be used.
- Screw posts are moved inside.
- The pro micro holder has been modified. Dupont cables can be used.

## Future plans (PR is welcome)

- Move screw posts 3mm upwards so that the bottom plate can be inserted into the case.
- Add smoothing.

## Getting the case and bottom plate

### Option 1: 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

### Option 2: Download from Releases

Generated models (only 4x5) can be downloaded from [Releases](https://github.com/l4u/dactyl-manuform-mini-keyboard/releases).

### Option 3: Download from Thingiverse

[Dactyl ManuForm Mini on Thingiverse](https://www.thingiverse.com/l4u/collections/dactyl-manuform-mini)

### Option 4: Order from Shapeways

[Order from Shapeways](https://www.shapeways.com/shops/l4u)

## 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 2018-05-10 13:38:40 +08:00			`# Dactyl ManuForm Mini Keyboard`
Adding license 2015-03-07 07:25:36 +08:00
Update README 2018-04-21 14:21:56 +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).`
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-04-22 09:13:28 +08:00			`- Sidenub is disabled by default so that Kailh, Outemu and other switches can be`
			`used. If you use Cherry MX or Gateron switches, you can enable the sidenubs.`
			`- One key in the thumb cluster has been removed. Other thumb keys are also adjusted.`
			`- The total height is reduced and wire posts are removed. This results in a`
			`higher printing speed and a lower cost.`
Update readme 2018-04-21 10:07:41 +08:00			`- A TRRS mount instead of a RJ9 mount is used.`
			`- A micro USB mount is used. A breakout board, or an extension cable can be used.`
			`- Screw posts are moved inside.`
			`- The pro micro holder has been modified. Dupont cables can be used.`

			`## Future plans (PR is welcome)`

			`- Move screw posts 3mm upwards so that the bottom plate can be inserted into the case.`
			`- Add smoothing.`

Add shapeways link 2018-05-11 09:01:29 +08:00			`## Getting the case and bottom plate`
Update documents for getting models 2018-04-21 09:47:31 +08:00
			`### Option 1: 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`

Update documents for getting models 2018-04-21 09:47:31 +08:00			`### Option 2: Download from Releases`

			`Generated models (only 4x5) can be downloaded from [Releases](https://github.com/l4u/dactyl-manuform-mini-keyboard/releases).`

Update README 2018-04-22 09:13:28 +08:00			`### Option 3: Download from Thingiverse`

Add shapeways link 2018-05-11 09:01:29 +08:00			`[Dactyl ManuForm Mini on Thingiverse](https://www.thingiverse.com/l4u/collections/dactyl-manuform-mini)`

			`### Option 4: Order from Shapeways`

			`[Order from Shapeways](https://www.shapeways.com/shops/l4u)`
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).`