Cutieguwu/qmk_cli
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
143 Commits 7 Branches 73 Tags
6433cbc0f4a9dcedf9707a9de63d8f49871015e3
T
Clone
Open with VS Code Open with VSCodium Open with Intellij IDEA
Download ZIP Download TAR.GZ Download BUNDLE
Zach White 6433cbc0f4 this script uses bashisms
2021-03-27 09:13:59 -07:00
.github/workflows
Remove explicit setuptools upgrade from build action
2021-03-08 06:20:24 +11:00
qmk_cli
use the correct name
2021-03-27 09:04:51 -07:00
.editorconfig
Initial version of installable qmk_cli
2019-06-30 15:45:29 -07:00
.gitignore
Add a very lightly tested qmk setup
2019-07-01 00:11:18 -07:00
LICENSE
Initial commit
2019-06-30 12:00:34 -07:00
MANIFEST.in
rip out toml
2019-07-15 11:08:14 -07:00
qmk
Use flit to package instead of setuptools
2019-06-30 20:03:14 -07:00
README.md
write a quickstart
2021-03-02 07:36:49 -08:00
release
this script uses bashisms
2021-03-27 09:13:59 -07:00
requirements-dev.txt
update the release script
2020-12-02 10:34:35 -08:00
requirements.txt
Use flit to package instead of setuptools
2019-06-30 20:03:14 -07:00
setup.cfg
fix the python_requires var
2021-03-07 11:07:36 -08:00
setup.py
General improvements
2021-03-27 08:34:34 -07:00

README.md

QMK CLI

CLI Setup
A program to help users work with QMK Firmware.

Features

  • Interact with your qmk_firmware tree from any location
  • Use qmk clone to pull down anyone's qmk_firmware fork
  • Setup your build environment with qmk setup
  • Check that your environment is correctly setup with qmk doctor
  • Dispatches to qmk_firmware/bin/qmk for additional functionality:
    • qmk compile-json
    • More to come

Quickstart

Full documentation: https://docs.qmk.fm/#/tutorial

Basic steps:

  • python3 -m pip install qmk
  • qmk setup
Reference in New Issue View Git Blame Copy Permalink
S
Description
A program to help users work with QMK
Readme MIT 695 KiB
Languages
Python 100%