Skip to content

Commit 98d31c0

Browse files
authored
Update README.md
1 parent fb9323d commit 98d31c0

File tree

1 file changed

+66
-1
lines changed

1 file changed

+66
-1
lines changed

README.md

Lines changed: 66 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,75 @@
22

33
By some stroke of luck, you've made your way here. The Ploopy Mouse. Your life will never be the same.
44

5-
This repository contains the schematic for the Ploopy Mouse. If you're looking for Ploopy Mouse firmware, check out the [Ploopy Mouse QMK fork](https://github.com/ploopyco/qmk_firmware) (this is also a valid target for your QMK build environment).
5+
If you're looking to get your hands on a QMK-powered mouse, [check out our store link](https://www.ploopy.co/shop/mouse/5)!
6+
7+
This repository contains the schematic for the Ploopy Mouse. If you're looking for the firmware that gets shipped with every mouse, check out the [Ploopy Mouse QMK fork](https://github.com/ploopyco/qmk_firmware) (this is also a valid target for your QMK build environment).
8+
9+
QMK code for the Ploopy Mouse has been integrated into the [master of the QMK repository](https://github.com/qmk/qmk_firmware). If you prefer to get the latest code, look there. However, only code found in the official [Ploopy Mouse QMK fork](https://github.com/ploopyco/qmk_firmware) is guaranteed to be stable.
610

711
What are you waiting for? Your new life awaits.
812

913
## Under what license is this released?
1014

1115
The firmware is released under GPLv3, as per the license requirements set out in the original [QMK firmware](https://github.com/qmk/qmk_firmware). The PCB schematic is released under OHL CERN v1.2. Check the respective LICENSE.md files for full license text.
16+
17+
# How to Flash New Firmware
18+
19+
The Ploopy Mouse is fairly easy to program and reprogram, thanks to the excellent work by all of the developers and maintainers of the [QMK firmware suite](https://github.com/qmk/qmk_firmware). This guide will focus specifically on flashing firmware to the Ploopy Mouse.
20+
21+
## Before you begin
22+
23+
If you have never used QMK before, go through [all of the steps in the QMK guide to set up your environment](https://docs.qmk.fm/#/newbs_getting_started).
24+
25+
QMK was built for keyboards, so you'll see lots of references to code that looks like the following:
26+
27+
`-kb <keyboard>`
28+
29+
Whenever you see that, use the following syntax:
30+
31+
`-kb ploopyco/mouse`
32+
33+
and you'll be fine.
34+
35+
## Building the Ploopy Mouse firmware
36+
37+
With your terminal window open and pointed at your QMK build environment, compile the firmware with the following command:
38+
39+
`qmk compile -kb ploopyco/mouse -km via`
40+
41+
Alternatively, you can invoke the Makefile directly with the following:
42+
43+
`make ploopyco/mouse:via`
44+
45+
If you wish, you can use the default keymap (with `qmk compile -kb ploopyco/mouse -km default` or `make ploopyco/mouse:default`). However, the VIA keymap is particularly interesting because it allows for customization of the mouse's functions without reflashing the firmware, through the use of the convenient [VIA software package](https://github.com/the-via/releases/releases). It's incredibly handy, so definitely check it out.
46+
47+
For more details on building QMK firmware in general, see the [QMK firmware guide](https://docs.qmk.fm/#/newbs_building_firmware).
48+
49+
## Putting the Ploopy Mouse into bootloader mode
50+
51+
Putting the Ploopy Mouse into bootloader mode is very easy.
52+
53+
1. Unplug it from your computer.
54+
2. Hold the "back" button. This is the button on the side of the mouse that is closer to the bottom of your hand.
55+
3. While holding the back button, plug the Ploopy Mouse into your computer. If you're using QMK Toolbox, it should show up in the console. If using `dmesg`, it'll show up as an Atmel DFU device.
56+
57+
And that's it. While plugged in this way, the Ploopy Mouse will accept new firmware.
58+
59+
## Flashing the firmware
60+
61+
Use your preferred method of flashing QMK firmware.
62+
63+
- QMK Toolbox has been verified as working.
64+
- Using `dfu-programmer` from a terminal window has also been verified as working.
65+
66+
For more details, see the [QMK guide](https://docs.qmk.fm/#/newbs_flashing) on flashing firmware.
67+
68+
## And that's it!
69+
70+
Unplug it, replug it in, and you should be good to go!
71+
72+
Happy customizing!
73+
74+
## Acknowledgements
75+
76+
Very special thanks to [drashna](https://github.com/drashna). He wrote a ton of the code that makes this thing go. Check out some of his other projects!

0 commit comments

Comments
 (0)