: reset || F1 F2 F3 F12
: super shift bksp ctrl || alt space L0
-The [[https://atreus.technomancy.us/tmk][firmware]] includes a number of other options, including
-colemak, dvorak, and "software dvorak" which sends keycodes assuming
-the OS will perform the translation into dvorak. Adding new layouts or
-changing existing ones is easy.
+The [[https://atreus.technomancy.us/download][firmware]] includes a number of other options, including
+colemak and dvorak. [[https://atreus.technomancy.us/qmk][Customizing your layout]] is easy to do with the QMK configurator interface.
** Parts
*** Microcontroller
The circuit board design uses a [[http://www.pololu.com/product/3101][Pololu A-star micro]]. Hand-wired boards
-can also use a [[http://www.pjrc.com/teensy/index.html][Teensy 2]] or [[http://arduino.cc/en/Main/ArduinoBoardMicro][Arduino Pro Micro]].
+can also use a [[http://arduino.cc/en/Main/ArduinoBoardMicro][Arduino Pro Micro]].
Be sure to get a microcontroller without headers so it will fit in
between the bottom layer and the plate. USB micro is preferred over
shift, enter, etc) many of the labels will be incorrect if present.
Cherry switches have more options. This
-[[http://keyshop.pimpmykeyboard.com/products/full-keysets/dsa-blank-sets-1][DSA-shaped base set]] (spherical indentations on the key, same profile for each
+[[http://pimpmykeyboard.com/dsa-pbt-abs-blank-keycap-sets/][DSA-shaped base set]] (spherical indentations on the key, same profile for each
row) from Signature Plastics has 52 1x keys plus a few extras we won't
use. There are two "deep dish" keys in that set which you can place
under your index fingers on the home row to help guide your hands to
Layered laser-cut wood or acrylic. The [[http://geekhack.org/index.php?topic%3D54759.msg1304117#msg1304117][mark II case]] (EPS files in the
=case/= directory) features 8 screw holes and a kind of "stair step"
-design around the top and bottom of the key clusters; mark I is
-pictured below.
-
-The =3mm-alps-all.eps= file contains the top plate, bottom plate, and
-switch plate for Matias switches. =3mm.eps= contains the files for
-Cherry boards. These pieces can all be cut on 3mm acrylic or wood. The
-=spacer.eps= file should be cut on something thicker; between 4.5mm
-and 6mm is recommended. The spacer needs to be at least as thick as
-the connector of the USB cable you're using.
+design around the top and bottom of the key clusters; mark I has
+straight lines.
+
+The files =alps-top-plate-3mm.eps=, =alps-switch-plate-3mm.eps=, and
+=bottom-plate-3mm.eps= are to be cut in 3mm acrylic or wood. The
+=spacer.eps= file can be cut on something thicker; between 4.5mm and
+6mm is recommended. Alternatively you can cut it in 3mm twice. The
+spacer needs to be at least as thick as the connector of the USB cable
+you're using. If you are using Cherry switches, you should use
+=cherry-3mm.eps= for the top, switch, and bottom plates instead, but
+the spacer is the same.
There is also a programmatically-implemented version of the case
written in OpenSCAD; it is more flexible (you can tweak the number of
half. I did a run with 6mm acrylic of the other layers which took
nearly 6 minutes.
-Wood cases should be finished with sandpaper and finishing oil/wax or
-with [[https://atreus.technomancy.us/lacquer.pdf][lacquer]] which
-takes longer but feels nicer.
+Wood cases should be finished with sandpaper and lacquer, shellac, or polyurethane.
** Firmware
-The [[https://atreus.technomancy.us/tmk][TMK firmware]] is
-recommended. You should be able to change into the =keyboard/atreus=
-directory and run =make KEYMAP=qwerty= (or whichever variant you want)
-to produce a qwerty =atreus.hex= file. You will probably want to
-create your own layout once you've gotten a chance to try it and see
-what works for you. See the readme for instructions of how to upload
-it to the keyboard's controller.
+The [[https://qmk.fm][QMK firmware]] is
+recommended. [[https://atreus.technomancy.us/download][Standard
+layouts]] are available precompiled, or you can
+[[https://atreus.technomancy.us/qmk][design your own]] in the
+configurator.
-There is also the older [[https://github.com/technomancy/atreus-firmware][atreus-firmware]] custom codebase which works
-but has fewer features. It is recommended mostly for learning purposes
-since the code is much simpler and easier to understand than TMK.
+There is also the older
+[[https://github.com/technomancy/atreus-firmware][atreus-firmware]]
+custom codebase which works but has fewer features. It is recommended
+mostly for learning purposes since the code is much simpler and easier
+to understand than QMK. Previously TMK was the recommended choice for
+firmware, but QMK has much better documentation and ease of use and is
+now recommended.
** Bill of Materials
- 50 Matias or Cherry switches from mechanicalkeyboards.com
- 50 diodes from radio shack, ebay, or whatever
-- 40 1x, 2 1.5x Keycaps from signatureplastics.com OR full keycap set from matias.com
+- 40 1x, 2 1.5x Keycaps from signatureplastics.com OR full keycap set from matias.ca
- A-star micro from pololu.com
- Case materials from various sources
- Case laser cutting: 7.5 minutes on a 100W Epilog laser; varies by source
** Orestes
-A new [[https://www.flickr.com/photos/technomancy/14654421878][experimental build]] uses the [[http://pjrc.com/store/teensy31.html][Teensy 3]] microcontroller and
-ARM [[https://github.com/technomancy/orestes/tree/teensy3][Forth-based]] firmware, but this is not yet suitable for general-purpose use.
+An [[https://www.flickr.com/photos/technomancy/14654421878][experimental build]] uses the [[http://pjrc.com/store/teensy31.html][Teensy 3]] microcontroller and
+ARM [[https://github.com/technomancy/orestes/tree/teensy3][Forth-based]] firmware, but this is not really suitable for general-purpose use; it's more of a curiosity.
** License
-Copyright © 2014-2016 Phil Hagelberg and contributors
+Copyright © 2014-2018 Phil Hagelberg and contributors
Released under the [[https://www.gnu.org/licenses/gpl.html][GNU GPL version 3]]
projects / atreides.git / blobdiff