summaryrefslogtreecommitdiff
path: root/keyboards/navi10/readme.md
diff options
context:
space:
mode:
authorEthan Durrant <5387347+emdarcher@users.noreply.github.com>2019-12-08 23:31:30 -0700
committerJames Young <18669334+noroadsleft@users.noreply.github.com>2019-12-08 22:31:30 -0800
commit6c834dea7b506db480ae7a96f3b35f955824d4ec (patch)
treebf48a09503d2945189c3067e6dfb04509f590511 /keyboards/navi10/readme.md
parentb3c7864990be0a80177aa35b32fb000419696636 (diff)
[Keyboard] Adding Navi10 macropad (#7556)
* working on keymap and files for the navi10 * fixing and modifying tap dance keys and layers * cleanup, and adding my separate keymap * edited and simplified the default keymap * cleaned up files and added support for future rev2 board * readme edits * moved rev0 specific keymap to it's own folder * added revision data to the config files * added DEFAULT_FOLDER * added note on compiling for a specific revision * documentation and readme edits * moved keymaps around and cleaned up * added photo * formatting and cleanup * fixing whitespace * moving the tap dance enable to keymap folders
Diffstat (limited to 'keyboards/navi10/readme.md')
-rw-r--r--keyboards/navi10/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/navi10/readme.md b/keyboards/navi10/readme.md
new file mode 100644
index 0000000000..58a94711f2
--- /dev/null
+++ b/keyboards/navi10/readme.md
@@ -0,0 +1,19 @@
+# Navi10 / ナビ10
+
+![navi10](https://i.imgur.com/QpFCMFd.jpg)
+
+A simple and fun navigation cluster macropad with exposed components.
+
+* Keyboard Maintainer: [emdarcher](https://github.com/emdarcher)
+* Hardware Supported: Navi10
+* Hardware Availability: [KeyHive](https://www.keyhive.xyz/)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make navi10:default
+
+Make example for a specific revision (ex. rev2):
+
+ make navi10/rev2:default
+
+See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).