summaryrefslogtreecommitdiffstats
path: root/keyboards/proton_c/readme.md
diff options
context:
space:
mode:
authorJack Humbert <jack.humb@gmail.com>2018-11-02 17:44:57 +0100
committerGitHub <noreply@github.com>2018-11-02 17:44:57 +0100
commit34112dac36482edbd5331eac3dfe436752ff7653 (patch)
treef84b85d1290cdc94abd71f79300d619ed2af7a06 /keyboards/proton_c/readme.md
parent15f6278aa623ceda4c220daee1cbedb9e38e6a97 (diff)
downloadqmk_firmware-34112dac36482edbd5331eac3dfe436752ff7653.tar.gz
qmk_firmware-34112dac36482edbd5331eac3dfe436752ff7653.tar.xz
Adds the Proton C base project (#4224)
* adds proton c base * fixes custom matrix include * adds readme.md * usable pins, readme update
Diffstat (limited to 'keyboards/proton_c/readme.md')
-rw-r--r--keyboards/proton_c/readme.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/keyboards/proton_c/readme.md b/keyboards/proton_c/readme.md
new file mode 100644
index 000000000..5f27795ae
--- /dev/null
+++ b/keyboards/proton_c/readme.md
@@ -0,0 +1,16 @@
+Proton C
+===
+
+![Proton C](https://i.imgur.com/xZrjIqa.jpg)
+
+A Pro Micro drop-in replacement.
+
+Keyboard Maintainer: [Jack Humbert](https://github.com/jackhumbert)
+Hardware Supported: QMK Proton C
+Hardware Availability: [List of vendors](https://qmk.fm/proton-c)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make proton_c: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).