From 369c3e150ac549353efd2d11e609f119d69f8d34 Mon Sep 17 00:00:00 2001 From: Zach White Date: Thu, 12 Aug 2021 11:18:15 -0700 Subject: [PATCH] document building and packages in the readme --- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/README.md b/README.md index 92ec404..b93cea1 100644 --- a/README.md +++ b/README.md @@ -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: