summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorArmaan Bhojwani <me@armaanb.net>2021-01-15 11:28:41 -0500
committerArmaan Bhojwani <me@armaanb.net>2021-01-15 11:28:41 -0500
commit0798daa3209af07c4170784912ac81cc97dfd4e6 (patch)
treed942afe7b94827d6dac03a5e3cb6e94de438daab
parentb1d8f36a71e272dfe30816bb707d5cca694cf363 (diff)
downloadatreides-0798daa3209af07c4170784912ac81cc97dfd4e6.tar.gz
Update README
-rw-r--r--README.md22
1 files changed, 12 insertions, 10 deletions
diff --git a/README.md b/README.md
index 5128c76..77438cf 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,26 @@
-# atreides keyboard
-This keyboard is a fork of the [Atreus](https://gitlab.com/technomancy/atreides) keyboard with the notable additions of:
- - A bank of function keys on the left
- - A trackpoint
- - A rotary encoder
- - An OLED screen
+# atreides
+This keyboard is a derivative of the [Atreus](https://gitlab.com/technomancy/atreides) keyboard with the notable additions of a trackpoint and an OLED screen.
There is no pre-made PCB, it must be hardwired.
+From [Wikipedia](https://en.wikipedia.org/wiki/atreus):
+
+>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.
+
## Case
-The case design is written in OpenSCAD, and is easily tweakable to your liking. Wood cases should be finished with sandpaper and lacquer, shellac, or polyurethane.
+The case design is written in OpenSCAD with the intention of 3D printing or laser cutting it, and is easily tweakable to your liking with the variables included in the top of the file.
+
+Wood cases should be finished with sandpaper and lacquer, shellac, or polyurethane.
## Bill of Materials
- - 47 Cherry compatible switches
+ - 44 Cherry compatible switches
- 50 diodes
- - 40 1u and 2 1.5u keycaps
+ - 44 1u keycaps (flat profiles preferred)
- Pro Micro compatible microcontroller without headers
- Case materials
- Micro-USB cable
## License
-Copyright © 2014-2020 Phil Hagelberg and contributors, 2021 Armaan Bhojwani <me@armaanb.net>
+Copyright © 2014-2020 Phil Hagelberg and contributors, 2021 Armaan Bhojwani
Released under the GNU GPLv3, see the LICENSE file for more information.