From 9c6123483bf3c20d15bc63ee31f9619d821cf743 Mon Sep 17 00:00:00 2001 From: Zach White Date: Sun, 28 Mar 2021 16:23:15 -0700 Subject: [PATCH] housekeeping --- README.md | 17 ++++++++++------- setup.py | 6 +++--- 2 files changed, 13 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 5ca735b..33aa4fd 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ # QMK CLI [![CLI Setup](https://github.com/qmk/qmk_cli/workflows/CLI%20Setup/badge.svg)](https://github.com/qmk/qmk_cli/actions?query=workflow%3A%22CLI+Setup%22) + A program to help users work with [QMK Firmware](https://qmk.fm/). # Features @@ -8,15 +9,17 @@ A program to help users work with [QMK Firmware](https://qmk.fm/). * 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 +* Integrates with your qmk_firmware for additional functionality: + * `qmk c2json` + * `qmk compile` + * `qmk flash` + * `qmk json2c` + * `qmk lint` + * `qmk new-keymap` # Quickstart -Full documentation: - -Basic steps: - * `python3 -m pip install qmk` * `qmk setup` + +Full documentation: diff --git a/setup.py b/setup.py index ab3235e..3b939a7 100644 --- a/setup.py +++ b/setup.py @@ -24,7 +24,7 @@ if __name__ == "__main__": long_description=long_description, long_description_content_type="text/markdown", packages=find_packages(), - py_modules=['milc'], + py_modules=['qmk_cli'], classifiers=[ 'Development Status :: 3 - Alpha', 'Environment :: Console', @@ -47,9 +47,9 @@ if __name__ == "__main__": "flake8", "hjson", "jsonschema>=3", - "milc>=1.0.8", + "milc>=1.3.0", "nose2", "pygments", "yapf" - ], + ] )