Skip to content

Latest commit

 

History

History
executable file
·
31 lines (17 loc) · 2.04 KB

README.md

File metadata and controls

executable file
·
31 lines (17 loc) · 2.04 KB

VIA Keyboards

android-chrome-192x192

Definitions

VIA is a powerful, open-source web-based interface for configuring your QMK-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 Master branch.
  2. Your keymaps/via keymap MUST be merged in VIA's QMK Userspace Repository Main branch.
  3. Create a definition in JSON format for your keyboard and submit it as a pull request to VIA's Keyboards Repository Master branch.

Please follow our Specification documentation 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 details on how to create it.

Facing Issues?

If you encounter any issues or bugs while using the VIA Web Application, please report them by opening an issue in the VIA Web Application Repository. 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!