X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;ds=sidebyside;f=keyboards%2Fatomic%2Freadme.md;h=ab2fa4a23975f6b66b71173bfb645416c56b2744;hb=8da9d3330e7904c57b240cfb1b2d3312ad81ccf9;hp=ab1e7ba1ff8ded2afe672b0276d7742ef50f0e52;hpb=23617779b44a4be83a055e01eaced184d5cc1a73;p=qmk_firmware.git diff --git a/keyboards/atomic/readme.md b/keyboards/atomic/readme.md index ab1e7ba1f..ab2fa4a23 100644 --- a/keyboards/atomic/readme.md +++ b/keyboards/atomic/readme.md @@ -1,25 +1,16 @@ -Atomic keyboard firmware -====================== -DIY/Assembled ortholinear 60% keyboard by [Ortholinear Keyboards](http://ortholinearkeyboards.com). +Atomic +=== -## Quantum MK Firmware +![Atomic](http://i.imgur.com/3gNDJAh.jpg) -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`. - -### 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 `.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 `KEYMAP` option like: -``` -$ make KEYMAP=[default|jack|] -``` -Keymaps follow the format **__\.c__** and are stored in the `keymaps` folder. +See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. \ No newline at end of file