Skip to content

Commit

Permalink
Merge branch 'the-via:master' into kradoindustries-dev-branch
Browse files Browse the repository at this point in the history
  • Loading branch information
Feags authored Feb 9, 2025
2 parents c2bf093 + 34e4d03 commit 529013c
Show file tree
Hide file tree
Showing 18 changed files with 2,738 additions and 8 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ jobs:

- name: Build
run: |
npm ci
npm ci
npm run build
- uses: actions/upload-artifact@v3
- uses: actions/upload-artifact@v4
if: always()
with:
name: build-error
Expand Down
29 changes: 29 additions & 0 deletions README.md
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!

2 changes: 1 addition & 1 deletion src/40percentclub/mf68/mf68.json
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,
Expand Down
2 changes: 1 addition & 1 deletion src/40percentclub/nein/nein.json
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,
Expand Down
2 changes: 1 addition & 1 deletion v3/40percentclub/mf68/mf68.json
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,
Expand Down
2 changes: 1 addition & 1 deletion v3/40percentclub/nein/nein.json
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,
Expand Down
Loading

0 comments on commit 529013c

Please sign in to comment.