diff options
| author | Kenneth Aloysius <krusli@users.noreply.github.com> | 2017-10-17 10:31:39 +1100 |
|---|---|---|
| committer | Jack Humbert <jack.humb@gmail.com> | 2017-10-16 13:31:39 -1000 |
| commit | b7bb92396286b495e48864b5813e7dafcade93f5 (patch) | |
| tree | 746a47586fa93610ef2aebd49954d35e3285f8b5 /keyboards/niu_mini/keymaps/readme.md | |
| parent | 0f5928fdf4399f14a500a00936a2cc35225cd3bf (diff) | |
| download | qmk_firmware-b7bb92396286b495e48864b5813e7dafcade93f5.tar.gz qmk_firmware-b7bb92396286b495e48864b5813e7dafcade93f5.zip | |
Add NIU Mini from KBDFans (#1847)
* Add NIU Mini keymap from Planck keymap
* Remove old keymap files
* Fix README, removed Planck references
* Add default layout, move Planck layout to separate folder
* Update README
Diffstat (limited to 'keyboards/niu_mini/keymaps/readme.md')
| -rw-r--r-- | keyboards/niu_mini/keymaps/readme.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/niu_mini/keymaps/readme.md b/keyboards/niu_mini/keymaps/readme.md new file mode 100644 index 0000000000..804a657e7c --- /dev/null +++ b/keyboards/niu_mini/keymaps/readme.md @@ -0,0 +1,23 @@ +# How to add your own keymap + +Folders can be named however you'd like (will be approved upon merging), or should follow the format with a preceding `_`: + + _[ISO 3166-1 alpha-2 code*]_[layout variant]_[layout name/author] + +\* See full list: https://en.wikipedia.org/wiki/ISO_3166-1#Officially_assigned_code_elements + +and contain the following files: + +* `keymap.c` +* `readme.md` *recommended* +* `config.h` *optional*, found automatically when compiling +* `Makefile` *optional*, found automatically when compling + +When adding your keymap to this list, keep it organised alphabetically (select list, edit->sort lines), and use this format: + + * **folder_name** description + +# List of keymaps + +- **default** default layout from KBDFans +- **planck** Planck default layout |