Add images to readme.

This commit is contained in:
Phil Hagelberg 2020-03-22 16:26:15 -07:00
parent 9a4c5f8dd9
commit 7703babd99
3 changed files with 9 additions and 1 deletions

View file

@ -4,6 +4,8 @@ A firmware for the
[Atreus](http://atreus.technomancy.us) keyboard, written in [Atreus](http://atreus.technomancy.us) keyboard, written in
[Microscheme](https://ryansuchocki.github.io/microscheme/). [Microscheme](https://ryansuchocki.github.io/microscheme/).
![Atreus keyboard](atreus.jpg)
See [this article about how it works](https://atreus.technomancy.us/firmware). See [this article about how it works](https://atreus.technomancy.us/firmware).
## Features ## Features
@ -51,16 +53,22 @@ used to flash a new firmware once this is uploaded.
## Layout ## Layout
![layout](layout.png)
By default you get the qwerty layout. You can copy `qwerty.scm` to By default you get the qwerty layout. You can copy `qwerty.scm` to
`mylayout.scm` and make changes, (you can see a list of available `mylayout.scm` and make changes, (you can see a list of available
keycodes in `keycodes.scm`) then upload with: keycodes in `keycodes.scm`) then upload with:
$ make upload USB=/dev/ttyACM0 LAYOUT=multidvorak $ make upload USB=/dev/ttyACM0 LAYOUT=mylayout
There is also a `multidvorak` layout which is designed to send There is also a `multidvorak` layout which is designed to send
the right keycodes with the assumption that the OS is set to use the right keycodes with the assumption that the OS is set to use
Dvorak, but it also includes layers for "hard Dvorak". Dvorak, but it also includes layers for "hard Dvorak".
The default layout is based on the Keyboardio Atreus, except that for
older 42-key builds, the percent key is replaced with backtick, and
backslash is fn+semicolon.
## Development ## Development
The firmware can also be run on a PC rather than on the The firmware can also be run on a PC rather than on the

BIN
atreus.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 60 KiB

BIN
layout.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 62 KiB