summaryrefslogtreecommitdiffstats
path: root/keyboards/handwired/space_oddity/readme.md
diff options
context:
space:
mode:
authorJames <32029516+broken-username@users.noreply.github.com>2017-10-21 22:04:35 +0200
committerJack Humbert <jack.humb@gmail.com>2017-10-21 22:04:35 +0200
commitab3dbd8daad0554104862f97e33291973bbef7ed (patch)
tree616492583d13c4238037ec798cdc8128d0ebad12 /keyboards/handwired/space_oddity/readme.md
parent1954ad1fd88dd2fb55041e722eaa64922b06e30a (diff)
downloadqmk_firmware-ab3dbd8daad0554104862f97e33291973bbef7ed.tar.gz
qmk_firmware-ab3dbd8daad0554104862f97e33291973bbef7ed.tar.xz
Additional custom handwired layout - Space Oddity (#1868)
* Add existing file * Add new keyboard layout - initial commit * Revised readme.md * Clarified readme.md, reorganized keymap.c, and added license text. * Fixing last incomplete commit * Just a little code cleanup to make things more readable.
Diffstat (limited to 'keyboards/handwired/space_oddity/readme.md')
-rw-r--r--keyboards/handwired/space_oddity/readme.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/keyboards/handwired/space_oddity/readme.md b/keyboards/handwired/space_oddity/readme.md
new file mode 100644
index 000000000..1dadcb8a9
--- /dev/null
+++ b/keyboards/handwired/space_oddity/readme.md
@@ -0,0 +1,25 @@
+Space Oddity Keyboard
+=====================
+
+This firmware is for an Emacs-focused handwired custom keyboard using an Arduino Pro Micro.
+
+As originally designed, the top row consists of 2u keys which are used for user-defined macros. The keys for Shift and Enter are 1.75u.
+
+Some simple example macros are included. To add your own, simply add the number of the macro you want in the appropriate section.
+
+A picture of the finished product can be found here: https://imgur.com/dE9Y4XK
+
+## Pinout
+
+The following pins are used:
+- Columns 1-12: B2, B6, B5, B4, E6, D7, C6, D4, D0, D1, D2, D3
+- Rows 1-6: F4, F5, F6, F7, B1, B3
+
+## Compiling and loading the firmware
+
+To build the firmware, run `make handwired/space-oddity` from the toplevel directory.
+
+On GNU/Linux, you can flash the default layout onto the microcontroller by using `avrdude -p atmega32u4 -P /dev/ttyACM0 -c avr109 -U flash:w:handwired_space_oddity_default.hex`. Note that the device name under `/dev` may be different.
+
+
+This design was conceived by James Taylor. Any requests for further information and/or tips for building your own are welcome! \ No newline at end of file