aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/ft/mars80/readme.md
diff options
context:
space:
mode:
authorMechMerlin <30334081+mechmerlin@users.noreply.github.com>2019-05-17 12:54:10 -0700
committerDrashna Jaelre <drashna@live.com>2019-05-17 12:54:10 -0700
commit8be32e98d8bd112c24b292d9c25a94f6e2ed71ac (patch)
tree98555a0b6012d4b15b33844475f1774b32dd2596 /keyboards/ft/mars80/readme.md
parent49464be64559710318f4d8edc5a92a7a90784734 (diff)
downloadfirmware-8be32e98d8bd112c24b292d9c25a94f6e2ed71ac.tar.gz
firmware-8be32e98d8bd112c24b292d9c25a94f6e2ed71ac.tar.bz2
firmware-8be32e98d8bd112c24b292d9c25a94f6e2ed71ac.zip
[Keyboard] New Keyboard: Mars 8.0 TKL (#5894)
* fix the things the stupid script broke * create an appropriate LAYOUT macro using LAYOUT_tkl_ansi * create an appropriate keymap stolen from the phantom default keymap * add correct pins used and rgb led numbers * change vendor and device name * add QMK Configurator support * fix up RGB underglow * update readme * introduce new layout macro tkl_iso * add QMK Configurator support for new layout macro * enable backlight and add community layout support
Diffstat (limited to 'keyboards/ft/mars80/readme.md')
-rw-r--r--keyboards/ft/mars80/readme.md44
1 files changed, 44 insertions, 0 deletions
diff --git a/keyboards/ft/mars80/readme.md b/keyboards/ft/mars80/readme.md
new file mode 100644
index 000000000..962275133
--- /dev/null
+++ b/keyboards/ft/mars80/readme.md
@@ -0,0 +1,44 @@
+# Mars 8.0
+
+TKL Keyboard with in switch backlight and RGB Underglow.
+
+Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
+Hardware Supported: Mars 8.0 PCB
+Hardware Availability: [Geekhack Group Buy](https://geekhack.org/index.php?topic=93723.0)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make ft/mars80:default
+
+Flashing
+
+ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods.
+
+**Reset Key:** Hold down the key located at `K00`, commonly programmed as `Pause/Break` while plugging in the keyboard.
+
+Windows:
+1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
+2. Place your keyboard into reset.
+3. Press the `Find Device` button and ensure that your keyboard is found.
+4. Press the `Open .hex File` button and locate the `.hex` file you created.
+5. Press the `Flash Device` button and wait for the process to complete.
+
+macOS:
+1. Install homebrew by typing the following:
+ ```
+ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
+ ```
+2. Install `crosspack-avr`.
+ ```
+ brew cask install crosspack-avr
+ ```
+3. Install the following packages:
+ ```
+ brew install python3
+ pip3 install pyusb
+ brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
+ ```
+4. Place your keyboard into reset.
+5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
+
+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).