From f82235e12eab502f70b51440f6ec39d4dc8a346b Mon Sep 17 00:00:00 2001 From: skullY Date: Sun, 30 Jun 2019 20:21:14 -0700 Subject: [PATCH] Add a description for the project --- README.md | 17 ++++++++++++++++- pyproject.toml | 1 + qmk_cli/__init__.py | 2 +- 3 files changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c11eb67..6345bfa 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,17 @@ -# qmk_cli +# QMK CLI + A program to help users work with QMK + +# 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 + +To be written. diff --git a/pyproject.toml b/pyproject.toml index 438c7d5..65e82c9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,6 +7,7 @@ dist-name = "qmk" module = "qmk_cli" author = "skullydazed" author-email = "skullydazed@gmail.com" +description-file = "README.md" home-page = "https://github.com/qmk/qmk_cli" classifiers = [ 'Development Status :: 3 - Alpha', diff --git a/qmk_cli/__init__.py b/qmk_cli/__init__.py index 193e13f..6defb34 100644 --- a/qmk_cli/__init__.py +++ b/qmk_cli/__init__.py @@ -1,3 +1,3 @@ """A program to help you work with qmk_firmware.""" -__version__ = '0.0.1' +__version__ = '0.0.2'