diff options
| author | Ryan Winchester <ryan@sevenshores.co> | 2022-05-20 16:59:56 -0300 |
|---|---|---|
| committer | Ryan Winchester <ryan@sevenshores.co> | 2022-05-20 16:59:56 -0300 |
| commit | 068b1ff56a6f77092c5d3924831fd498e994c620 (patch) | |
| tree | ee0677a6ac5643e93b874b82de640ce62eacae0b /README.md | |
| parent | 68fe75d403909988c100e39ac8775a6642b3931b (diff) | |
Add local build option with Docker and README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..16001e8 --- /dev/null +++ b/README.md @@ -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. |