aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/ares/readme.md
diff options
context:
space:
mode:
authorGravatar Maarten Dekkers <maartenwut@gmail.com>2019-05-25 03:33:37 +0200
committerGravatar MechMerlin <30334081+mechmerlin@users.noreply.github.com>2019-05-24 18:33:37 -0700
commit1a55d84224609c935a5a98d2e824c6773353162f (patch)
tree6cb8af4e2a7a8c7f9f0d348b136c8db4897be17a /keyboards/ares/readme.md
parent1da8ad86689ae8fe8c5852201c5914e745f0f38e (diff)
downloadqmk_firmware-1a55d84224609c935a5a98d2e824c6773353162f.tar.gz
Add support for LSJ Ares (#5588)
* Add support for LSJ Ares Thanks to the other ports which have made this port possible. * Update Ares code per request * More changes to Ares * Update Ares rules.mk Co-Authored-By: Maartenwut <maartenwut@gmail.com> * Remove escaping backslashes from Ares default keymap
Diffstat (limited to 'keyboards/ares/readme.md')
-rw-r--r--keyboards/ares/readme.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/keyboards/ares/readme.md b/keyboards/ares/readme.md
new file mode 100644
index 000000000..338113a13
--- /dev/null
+++ b/keyboards/ares/readme.md
@@ -0,0 +1,42 @@
+lSJ Ares
+========
+
+Keyboard Maintainer: QMK Community
+Hardware Supported: LSJ Ares PCB
+Hardware Availability: https://geekhack.org/index.php?topic=93146.0
+
+Make example for this keyboard (after setting up your build environment):
+
+ make ares:default
+
+Flashing
+
+ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods.
+
+Windows:
+1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
+2. Place your keyboard into reset by holding the left control key and plugging the cable in.
+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 python
+ brew 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 [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.