diff options
| author | Jack Humbert <jack.humb@gmail.com> | 2017-06-25 12:40:25 -0400 |
|---|---|---|
| committer | Jack Humbert <jack.humb@gmail.com> | 2017-06-25 12:40:25 -0400 |
| commit | 1a4a66fd015990942a7248160aa63eb2fa6e59af (patch) | |
| tree | c20b700a97d9bae401bda82c7be2333a9be0c8eb /keyboards/atomic | |
| parent | 169ede07155764deb6a559f0438b1b7fa7138bef (diff) | |
| download | qmk_firmware-1a4a66fd015990942a7248160aa63eb2fa6e59af.tar.gz qmk_firmware-1a4a66fd015990942a7248160aa63eb2fa6e59af.zip | |
updates olkb readmes #1362
Diffstat (limited to 'keyboards/atomic')
| -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 674dcf113..1224c415f 100644 --- a/keyboards/atomic/readme.md +++ b/keyboards/atomic/readme.md | |||
| @@ -1,26 +1,16 @@ | |||
| 1 | Atomic keyboard firmware | 1 | Atomic |
| 2 | ====================== | 2 | === |
| 3 | DIY/Assembled ortholinear 60% keyboard by [Ortholinear Keyboards](http://ortholinearkeyboards.com). | ||
| 4 | 3 | ||
| 5 | ## Quantum MK Firmware | 4 |  |
| 6 | 5 | ||
| 7 | For the full Quantum feature list, see [the parent readme.md](/readme.md). | 6 | A compact 60% (15x5) ortholinear keyboard kit made and sold by OLKB. [More info on qmk.fm](http://qmk.fm/atomic/) |
| 8 | 7 | ||
| 9 | ## Building | 8 | Keyboard Maintainer: [Jack Humbert](https://github.com/jackhumbert) |
| 9 | Hardware Supported: Atomic PCB rev1, Teensy 2.0 | ||
| 10 | Hardware Availability: no longer available | ||
| 10 | 11 | ||
| 11 | 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. | 12 | Make example for this keyboard (after setting up your build environment): |
| 12 | 13 | ||
| 13 | Depending on which keymap you would like to use, you will have to compile slightly differently. | 14 | make atomic-default |
| 14 | 15 | ||
| 15 | ### Default | 16 | 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 |
| 16 | To build with the default keymap, simply run `make default`. | ||
| 17 | |||
| 18 | ### Other Keymaps | ||
| 19 | 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. | ||
| 20 | |||
| 21 | To build the firmware binary hex file with a keymap just do `make` with a keymap like this: | ||
| 22 | |||
| 23 | ``` | ||
| 24 | $ make [default|jack|<name>] | ||
| 25 | ``` | ||
| 26 | Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder. | ||