Add local build option with Docker and README

2022-05-20 16:59:56 -03:00
parent 68fe75d403
commit 068b1ff56a
7 changed files with 75 additions and 0 deletions
@@ -0,0 +1,24 @@
+# ADV360-PRO-ZMK
+
+## To build Firmware in GitHub Actions
+
+### Setup
+
+1. Fork this repo.
+2. Enable GitHub Actions on your fork.
+
+### Build firmware
+
+1. Push a commit to trigger the build.
+2. Download the artifact.
+
+## To build Firmware locally using Docker
+
+### Setup
+
+1. Execute `setup.sh`.
+
+### Build firmware
+
+1. Execute `run.sh`
+2. Check the `firmware` directory for the latest firmware build.