Menra11/rmk-gui

Gui configuration for RMK based on Tauri and Nuxt

本项目当前正处于史诗级屎山构建阶段, 建议您保持安全距离观赏.

This project is currently in the process of building an epic-level shit mountain. It is recommended to observe from a safe distance.

Home	Keymap

It is still in the early stages of development, and the preview images only represent the current state.

Go to the release page to download the corresponding installation package Supports Windows (x64/x86), Linux (x64/arm64) and macOS 10.15+ (intel/apple).

• Based on Rust and Tauri2 frameworks.
• Concise and modern user interface.
• Support for Windows, macOS, and Linux.

Make sure you have Rust and Node.js installed on your system.

1. Clone the repository:

   git clone https://github.com/liyang8246/rmk-gui.git
   cd rmk-gui

2. Install dependencies:

   pnpm install

3. Start the development server:

   pnpm dev

4. Build the application:

   pnpm build

Too many to write

RMK-GUI was based on or inspired by these projects and so on:

• Tauri A framework for building tiny, fast binaries for all major desktop and mobile platforms.
• Nuxt An open source framework that makes web development intuitive and powerful.
• Vial-gui An open-source cross-platform (Windows, Linux and Mac) GUI and a QMK fork for configuring your keyboard in real time.
• RMK Rust keyboard firmware library with layers, macros, real-time keymap editing, wireless(BLE) and split support.

RMK-GUI is licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.