aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/eve/meteor/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/eve/meteor/readme.md')
-rw-r--r--keyboards/eve/meteor/readme.md51
1 files changed, 51 insertions, 0 deletions
diff --git a/keyboards/eve/meteor/readme.md b/keyboards/eve/meteor/readme.md
new file mode 100644
index 000000000..8e933c09d
--- /dev/null
+++ b/keyboards/eve/meteor/readme.md
@@ -0,0 +1,51 @@
+# EVE Meteor
+
+60% PCB with Function Row
+
+
+Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
+Hardware Supported: EVE Meteor
+Hardware Availability: [zFrontier](https://en.zfrontier.com/products/eve-meteor)
+
+
+Make example for this keyboard (after setting up your build environment):
+
+ make eve/meteor:default
+
+Flashing
+
+ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods.
+
+**Reset Key:** Short the two holes labeled `FW_JP` underneath the PCB, beside the Tab key while plugging in the keyboard.
+
+Do not confuse this with the LED holes of the switch in the `Tab` position. `FW_JP` is not reachable from the top as the plate blocks access to it.
+
+It is recommended to program a `RESET` key in your keymap.
+
+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).