add README

SonixQMK · Sep 14, 2024 · 9cc809e · 9cc809e
1 parent 179a9d6
commit 9cc809e
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,13 @@
+# SonixQMK Homebrew
+
+This repository contains Homebrew formulae for SonixQMK software.
+
+## How do I install these formulae?
+
+`brew install SonixQMK/sonixqmk/<formula>`
+
+Or `brew tap SonixQMK/sonixqmk` and then `brew install <formula>`.
+
+## Documentation
+
+`brew help`, `man brew` or check [Homebrew's documentation](https://docs.brew.sh).