sporq/qmk-firmware
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[Keyboard] SharkPCB release Beta compatibility (#16713)

Browse Source 
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
This commit is contained in:
Álvaro A. Volpato
2022-04-18 06:07:49 -03:00
committed by GitHub
parent fdd4af9973
commit 5fe3b9ffa5
24 changed files with 712 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
keyboards/acheron/shark/readme.md
View File

@@ -1,17 +1,46 @@
# Acheron Aχξρων 40-SM-O-MX-TH-WI (Codename "SharkPCB") QMK firmware
# SharkPCB QMK firmware
<p align="center">
<img align="middle" src="https://raw.githubusercontent.com/Gondolindrim/acheronLibrary/master/graphics/acheronLong.png" width="400">
</p>
![sharkpcb](https://acheronproject.com/images/shark/shark_beta_pic3_small.jpg)
This is the QMK firmware repository for the Shark, updated until [revision Alpha](https://github.com/Gondolindrim/SharkPCB/releases/tag/Alpha).
The SharkPCB is an open-source ortholinear 40% layout designed by Gondolindrim for the AcheronProject.
The SharkPCB is an Open-Hardware guidelines compliant PCB which files can be found at [this link](https://github.com/Gondolindrim/SharkPCB). Its designer and maintainer is [Gondolindrim](https://github.com/Gondolindrim).
* Keyboard Maintainer: [Gondolindrim](https://github.com/gondolindrim)
* Hardware Availability: you can get release Beta SharkPCBs using the JLCPCB manufacturer using the files at [its documentation](http:/acheronproject.com/pcbs/shark/shark/)
See the [AcheronDocs](https://gondolindrim.github.io/AcheronDocs/shark/intro.html) page for the SharkPCB full documentation.
## How to flash
Make example for this keyboard (after setting up your build environment):
### Enter bootloader
make acheron/shark:default
### Release Alpha:
The DFU state in the bootloader can be accessed in 2 ways:
* **Bootmagic reset**: hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
* **Physical reset button**: press the button on the back of the PCB
* **Keycode in layout**: press the key mapped to `RESET` if it is available (ESC key at layer 1 in the default layout)
### Release Beta:
The DFU state in the bootloader can be accessed in 3 ways:
* **Bootmagic reset**: hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
* **Physical reset button**: press the button on the back of the PCB, for at least five seconds
* **Keycode in layout**: press the key mapped to `RESET` if it is available (ESC key at layer 1 in the default layout)
## Compile firmware
### Release Alpha
After accessing the DFU state in your PCB, build the default layout using:
make acheron/shark/alpha:default
### Release Beta
After accessing the DFU state in your PCB, build the default layout using:
make acheron/shark/beta:default
Then download the resulting binary `*bin` file using `dfu-util` or QMK Toolbox.
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).