Cutieguwu/qmk_cli-mirror

mirror of https://github.com/qmk/qmk_cli.git synced 2026-07-25 16:42:55 -04:00

T

QMK Bot e851c8fcb5 New release: 0.0.43 → 0.0.44

2021-03-28 01:51:59 +00:00

.github/workflows

Setup an action to publish a release

2021-03-27 18:38:47 -07:00

New release: 0.0.43 → 0.0.44

2021-03-28 01:51:59 +00: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

New release: 0.0.43 → 0.0.44

2021-03-28 01:51:59 +00:00

setup.py

General improvements

2021-03-27 08:34:34 -07:00

README.md

QMK CLI

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