Skip to content

Commit

Permalink
[sonixdocs] add SonixQMK info
Browse files Browse the repository at this point in the history
  • Loading branch information
dexter93 committed Sep 23, 2024
1 parent 483601b commit 9c6af56
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 3 deletions.
10 changes: 9 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,16 @@

QMK (*Quantum Mechanical Keyboard*) is an open source community centered around developing computer input devices. The community encompasses all sorts of input devices, such as keyboards, mice, and MIDI devices. A core group of collaborators maintains [QMK Firmware](https://github.com/qmk/qmk_firmware), [QMK Configurator](https://config.qmk.fm), [QMK Toolbox](https://github.com/qmk/qmk_toolbox), [qmk.fm](https://qmk.fm), and this documentation with the help of community members like you.

## What is SonixQMK?

SonixQMK is an open source community porting QMK to the [Sonix SN32 series](https://www.sonix.com.tw/category-en-947). The community maintains forks of QMK tools on [SonixQMK Firmware](https://github.com/SonixQMK/qmk_firmware), [SonixQMK Toolbox](https://github.com/SonixQMK/qmk_toolbox), as well as original tools like [SonixFlasher](https://github.com/SonixQMK/SonixFlasherC), [Jumploader](https://github.com/SonixQMK/sonix-keyboard-bootloader), a [database](https://github.com/SonixQMK/Mechanical-Keyboard-Database) of compatible keyboards, and this documentation with the help of community members like you.

## Get Started

::: tip Basic
[QMK Configurator](newbs_building_firmware_configurator)

User friendly graphical interfaces, no programming knowledge required.
User friendly graphical interfaces, no programming knowledge required.<sup>1</sup>
:::

::: warning Advanced
Expand All @@ -18,6 +22,10 @@ User friendly graphical interfaces, no programming knowledge required.
More powerful, but harder to use.
:::

Notes:

1. SonixQMK doesn't support the QMK Configurator at this point in time.

## Make It Yours

QMK has lots of features to explore, and a good deal of reference documentation to dig through. Most features are taken advantage of by modifying your [keymap](keymap), and changing the [keycodes](keycodes).
Expand Down
4 changes: 2 additions & 2 deletions docs/support.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ Please read our [Code of Conduct](https://qmk.fm/coc/) before participating in a

## Realtime Chat

If you need help with something, the best place to get quick support is going to be on our [Discord Server](https://discord.gg/qmk). There is usually somebody online, and there are a bunch of very helpful people there.
If you need help with something, the best place to get quick support is going to be on our [Discord Server](https://discord.gg/gqHaeQYuxS). There is usually somebody online, and there are a bunch of very helpful people there.

## OLKB Subreddit

The official QMK forum is [/r/olkb](https://reddit.com/r/olkb) on [reddit.com](https://reddit.com).

## GitHub Issues

You can open an [issue on GitHub](https://github.com/qmk/qmk_firmware/issues). This is especially handy when your issue will require long-term discussion or debugging.
You can open an [issue on GitHub](https://github.com/SonixQMK/qmk_firmware/issues). This is especially handy when your issue will require long-term discussion or debugging.

0 comments on commit 9c6af56

Please sign in to comment.