README.md

   1 # atreides
   2 This keyboard is a derivative of the [Atreus](https://gitlab.com/technomancy/atreides) keyboard with the notable addition of an OLED screen.
   3
   4 There is no pre-made PCB, it must be hardwired.
   5
   6 From [Wikipedia](https://en.wikipedia.org/wiki/atreus):
   7
   8 >The word Atreides refers to one of the sons of Atreus—Agamemnon and Menelaus. The plural form Atreidae or Atreidai refers to both sons collectively; in English, the form Atreides (the same form as the singular) is often used.
   9
  10 ## Case
  11 The case design is written in OpenSCAD with the intention of laser cutting it, and is easily tweakable to your liking with the variables included in the top of the file. The main parameters are:
  12   - `angle`, one half of the angle between the left and the right groups of keys
  13   - `n_rows`, `n_cols`, number of rows and columns to use
  14   - `staggering_offsets`, column staggering offsets
  15   - `cable_hole_width`, width of the hole for the USB cable
  16   - `hand_separation`, distance between the left and the right groups of keys
  17   - `screw_hole_radius`, radius of screw holes
  18   - `use_notched_holes` (boolean), whether notched Cherry MX switch holes are desired
  19
  20 See the comments in `atreides_case.scad` for details.
  21
  22 To use, open this script in OpenSCAD, select **Compile and Render (CGAL)** in the **Design** menu, then select **Export as DXF...**.
  23
  24 Wood cases should be finished with sandpaper and lacquer, shellac, or polyurethane.
  25
  26 ## Bill of Materials
  27  - 44 Cherry compatible switches
  28  - 50 diodes
  29  - 44 1u keycaps (flat profiles preferred)
  30  - Pro Micro compatible microcontroller without headers
  31  - Case materials
  32  - Micro-USB cable
  33
  34 ## License
  35 Copyright © 2014-2020 Phil Hagelberg and contributors, 2021 Armaan Bhojwani
  36
  37 Released under the GNU GPLv3, see the LICENSE file for more information.