Nulo/zmk-ardux
1
0
Fork 0
Code Releases Activity

rename README

Browse source
This commit is contained in:
Glen Goodwin 2022-04-30 12:58:35 -04:00
parent d49c6a800b
commit a02c8bd470
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -1,16 +1,16 @@
# ZMK ARTSEY Implementation # ZMK ARDUX Implementation
This repo contains the [ZMK](https://zmkfirmware.dev/) ARTSEY implementation and pre-built firmware for boards that have been setup to use ARTSEY by the core ARTSEY development team. This repo contains the [ZMK](https://zmkfirmware.dev/) ARDUX implementation and pre-built firmware for boards that have been setup to use ARDUX by the core ARDUX development team.
## Prebuilt Firmware ## Prebuilt Firmware
The `Releases` area of this repository contains the latest builds of the ZMK ARTSEY implementation. You can click on the most recent release and download the appropriate artifact for your MCU + board combination. Inside the zip file will be the necessary file for flashing your MCU. The `Releases` area of this repository contains the latest builds of the ZMK ARDUX implementation. You can click on the most recent release and download the appropriate artifact for your MCU + board combination. Inside the zip file will be the necessary file for flashing your MCU.
### Firmware Files ### Firmware Files
Inside the firmware zip file will be 4 files Inside the firmware zip file will be 4 files
- `artsey.dtsi`: The ARTSEY definition that was used for the build - `artsey.dtsi`: The ARDUX definition that was used for the build
- A file with `.dts.pre.tmp` at the end that is the generated DTS file used for the build (this is for any required troubleshooting) - A file with `.dts.pre.tmp` at the end that is the generated DTS file used for the build (this is for any required troubleshooting)
- A file with `-zmk-artsey.hex` at the end that is the hex firmware image that can be used to flash your MCU - A file with `-zmk-artsey.hex` at the end that is the hex firmware image that can be used to flash your MCU
- A file with `-zmk-artsey.uf2` at the end that is the uf2 firmware image that can be used to flash your MCU - A file with `-zmk-artsey.uf2` at the end that is the uf2 firmware image that can be used to flash your MCU
@ -19,9 +19,9 @@ Please Note: the `hex` and `uf2` files may or may not be present depending on yo
**We are NOT responsible for any failed firmware flashes!** **We are NOT responsible for any failed firmware flashes!**
## Adding ARTSEY Support ## Adding ARDUX Support
If you'd like to add ARTSEY support to a board that supports ZMK but is not built by this repo. Please follow the standard ZMK docs on how to add a new shield but using this repo as your `zmk-config` and open a Pull Request. If you'd like to add ARDUX support to a board that supports ZMK but is not built by this repo. Please follow the standard ZMK docs on how to add a new shield but using this repo as your `zmk-config` and open a Pull Request.
Also, update the `.github/workflows/build.yml` file for the new board being submitted. Also, update the `.github/workflows/build.yml` file for the new board being submitted.