summaryrefslogtreecommitdiff
path: root/keyboards/acheron/shark/README.md
diff options
context:
space:
mode:
authorÁlvaro A. Volpato <alvaro.volpato@usp.br>2019-10-25 08:27:43 +0200
committernoroadsleft <18669334+noroadsleft@users.noreply.github.com>2019-10-24 23:27:43 -0700
commit23048798dd4e089c6f636a198cb246f41e6aef73 (patch)
treef4e1a481a5230fae470641b0da51637e61b11075 /keyboards/acheron/shark/README.md
parente8453bbc1218a2cb40d4eac6cb543bd0c45d3de9 (diff)
[Keyboard] Add SharkPCB rev Alpha support (#7090)
* Add SharkPCB rev Alpha support * Solve PWM pin assignment - Solve PWM pin configuration for the SharkPCB rev.Alpha, which backlight pin is B0 * Update shark.c copyright name * Update shark.h copyright section * Apply suggestions from code review Suggestions from @zvecr and @drashna were accepted and applied for neater code. Also fixed typos and removed unused comments. See [pull request](https://github.com/qmk/qmk_firmware/pull/7090/files#diff-70c0a1f44287ae5810170b4180cdaa5d) for more information. Co-Authored-By: Joel Challis <git@zvecr.com> Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update PRODUCT_ID into config.h * Update metadata info.json Fields "keyboard_name", "keyboard_folder", "url", "maintainer" were updated
Diffstat (limited to 'keyboards/acheron/shark/README.md')
-rw-r--r--keyboards/acheron/shark/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/keyboards/acheron/shark/README.md b/keyboards/acheron/shark/README.md
new file mode 100644
index 0000000000..fbe9429f12
--- /dev/null
+++ b/keyboards/acheron/shark/README.md
@@ -0,0 +1,17 @@
+# Acheron Aχξρων 40-SM-O-MX-TH-WI (Codename "SharkPCB") QMK firmware
+
+<p align="center">
+ <img align="middle" src="https://raw.githubusercontent.com/Gondolindrim/acheronLibrary/master/graphics/acheronLong.png" width="400">
+</p>
+
+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-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).
+
+See the [AcheronDocs](https://gondolindrim.github.io/AcheronDocs/shark/intro.html) page for the SharkPCB full documentation.
+
+Make example for this keyboard (after setting up your build environment):
+
+ make acheron/shark:default
+
+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).