mirror of
https://github.com/qmk/qmk_cli.git
synced 2026-07-25 16:42:55 -04:00
document building and packages in the readme
This commit is contained in:
@@ -17,9 +17,43 @@ A program to help users work with [QMK Firmware](https://qmk.fm/).
|
||||
* `qmk lint`
|
||||
* ...and many more!
|
||||
|
||||
# Packages
|
||||
|
||||
We provide "install and go" packages for many Operating Systems.
|
||||
|
||||
## Linux
|
||||
|
||||
Packages for several distributions available here: https://github.com/qmk/qmk_fpm
|
||||
|
||||
## macOS
|
||||
|
||||
Using [Homebrew](https://brew.sh):
|
||||
|
||||
brew install qmk/qmk/qmk
|
||||
|
||||
## Windows
|
||||
|
||||
Download our custom MSYS2 installer here: https://msys.qmk.fm/
|
||||
|
||||
# Quickstart
|
||||
|
||||
* `python3 -m pip install qmk`
|
||||
* `qmk setup`
|
||||
|
||||
# Building
|
||||
|
||||
We follow PEP517, you can install using [build](https://pypi.org/project/build/):
|
||||
|
||||
Setup:
|
||||
|
||||
`python3 -m pip install build`
|
||||
|
||||
Build:
|
||||
|
||||
`python3 -m build`
|
||||
|
||||
You can read more about working with PEP517 packages in the [Python Packaging User Guide](https://packaging.python.org/guides/distributing-packages-using-setuptools/#packaging-your-project).
|
||||
|
||||
# Documentation
|
||||
|
||||
Full documentation: <https://docs.qmk.fm/#/tutorial>
|
||||
|
||||
Reference in New Issue
Block a user