From da8e8bb0fabdb814aea6f35564de8131c2338b77 Mon Sep 17 00:00:00 2001 From: Zeke Gabrielse Date: Wed, 17 Jan 2024 15:03:48 -0600 Subject: [PATCH] add build/publish notes --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 563541c..7e3659a 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,22 @@ To run tests, invoke `unittest`: python3 -m unittest ``` +## Building + +To build a release, run: + +```bash +python3 setup.py sdist bdist_wheel +``` + +## Publishing + +To publish a release, run: + +```bash +twine upload dist/* +``` + ## Thanks Special thanks to Denis Brodbeck for his Go package, [`machineid`](https://github.com/denisbrodbeck/machineid).