This repository has been archived on 2025-01-28. You can view files and clone it, but cannot push or open issues or pull requests.
noroadsleft 4c4ee4a26b NIU Mini Settings update and Refactor (#6651)
* update codebase to four-space indent

* update codebase to use #pragma once

* refactor config.h

* change info.json to debug linting

* refactor readme

- file header
- update docs links

* minimize and lint rules.mk

* change features

- enable mousekeys and nkro

* use GPIO commands for Status LED

Co-Authored-By: fauxpark <fauxpark@gmail.com>

* use IS_LED_ON macro

Co-Authored-By: fauxpark <fauxpark@gmail.com>

* update compile/flash examples in readme

* :flash doesn't use QMK Toolbox
2019-09-01 17:54:13 +10:00
..
2018-11-02 14:48:44 -07:00

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
  • mason
  • planck Planck default layout
  • xtonhasvim A Planck-like layout with a few tweaks and a vim emulation layer.
  • nosarthur Custom Colemak-dh layout and qwerty layout