diff options
Diffstat (limited to 'keyboards/atomic/readme.md')
| -rw-r--r-- | keyboards/atomic/readme.md | 30 |
1 files changed, 10 insertions, 20 deletions
diff --git a/keyboards/atomic/readme.md b/keyboards/atomic/readme.md index 674dcf113b..1224c415f0 100644 --- a/keyboards/atomic/readme.md +++ b/keyboards/atomic/readme.md @@ -1,26 +1,16 @@ -Atomic keyboard firmware -====================== -DIY/Assembled ortholinear 60% keyboard by [Ortholinear Keyboards](http://ortholinearkeyboards.com). +Atomic +=== -## Quantum MK Firmware + -For the full Quantum feature list, see [the parent readme.md](/readme.md). +A compact 60% (15x5) ortholinear keyboard kit made and sold by OLKB. [More info on qmk.fm](http://qmk.fm/atomic/) -## Building +Keyboard Maintainer: [Jack Humbert](https://github.com/jackhumbert) +Hardware Supported: Atomic PCB rev1, Teensy 2.0 +Hardware Availability: no longer available -Download or clone the whole firmware and navigate to the keyboards/atomic folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use `make dfu` to program your PCB once you hit the reset button. +Make example for this keyboard (after setting up your build environment): -Depending on which keymap you would like to use, you will have to compile slightly differently. + make atomic-default -### Default -To build with the default keymap, simply run `make default`. - -### Other Keymaps -Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create a file in the keymaps folder named `<name>.c` and see keymap document (you can find in top readme.md) and existent keymap files. - -To build the firmware binary hex file with a keymap just do `make` with a keymap like this: - -``` -$ make [default|jack|<name>] -``` -Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder. +See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.
\ No newline at end of file |