-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'the-via:master' into kradoindustries-dev-branch
- Loading branch information
Showing
18 changed files
with
2,738 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,31 @@ | ||
# VIA Keyboards | ||
|
||
![android-chrome-192x192](https://user-images.githubusercontent.com/1714072/222621960-ddfb8ee6-a486-4c66-8852-b204ba7c807b.png) | ||
|
||
![Definitions](https://github.com/the-via/keyboards/actions/workflows/build.yml/badge.svg) | ||
|
||
VIA is a powerful, open-source web-based interface for configuring your [QMK](https://qmk.fm)-powered mechanical keyboard. It allows you to customize your keymaps, create macros, and adjust RGB settings (if it has RGB) on the fly, without needing to recompile your keyboard's firmware. This makes keyboard customization easier and more accessible for everyone. | ||
|
||
## Getting VIA to support your keyboard | ||
|
||
Are you a keyboard maker or a developer interested in adding support for your keyboard? We welcome contributions to the VIA project! | ||
|
||
1. The source code of the keyboard **MUST be merged** in [QMK Firmware Repositories](https://github.com/qmk/qmk_firmware) Master branch. | ||
2. Your `keymaps/via` keymap **MUST be merged** in [VIA's QMK Userspace Repository](https://github.com/the-via/qmk_userspace_via) Main branch. | ||
3. Create a definition in JSON format for your keyboard and submit it as a pull request to [VIA's Keyboards Repository](https://github.com/the-via/keyboards) Master branch. | ||
|
||
Please follow our [Specification documentation](https://www.caniusevia.com/docs/specification) carefully to ensure your pull request is smoothly reviewed and merged. | ||
|
||
## What to add in this repository | ||
|
||
1. Add a `vendor/keyboardname` directory, inside the `v3` directory (e.g. `xelus/dawn60`) | ||
2. Add a `keyboardname.json` file to it | ||
|
||
Follow the [documentation](https://www.caniusevia.com/docs/specification) details on how to create it. | ||
|
||
## Facing Issues? | ||
|
||
If you encounter any issues or bugs while using the [VIA Web Application](https://usevia.app), please report them by opening an issue in the [VIA Web Application Repository](https://github.com/the-via/app/issues). This will help us to track down and resolve problems, and improve the VIA experience for everyone. | ||
|
||
Before reporting, please make sure to check if an issue has already been reported. Thank you! | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
{ | ||
"name": "MF68", | ||
"vendorId": "0x3430", | ||
"vendorId": "0x4025", | ||
"productId": "0x4D68", | ||
"matrix": { | ||
"rows": 8, | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
{ | ||
"name": "nein", | ||
"vendorId": "0x3430", | ||
"vendorId": "0x4025", | ||
"productId": "0x9999", | ||
"matrix": { | ||
"rows": 3, | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
{ | ||
"name": "MF68", | ||
"vendorId": "0x3430", | ||
"vendorId": "0x4025", | ||
"productId": "0x4D68", | ||
"matrix": { | ||
"rows": 8, | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
{ | ||
"name": "nein", | ||
"vendorId": "0x3430", | ||
"vendorId": "0x4025", | ||
"productId": "0x9999", | ||
"matrix": { | ||
"rows": 3, | ||
|
Oops, something went wrong.