aboutsummaryrefslogtreecommitdiffstats
path: root/readme.md
diff options
context:
space:
mode:
authorGravatar skullY <skullydazed@gmail.com>2019-07-05 11:08:18 -0700
committerGravatar skullydazed <skullydazed@users.noreply.github.com>2019-08-30 15:01:52 -0700
commit21df614a8ebf216f65822a28e319a05360f5244d (patch)
tree31a414dfc14fb596e4e04fbaeb8229db44f4d798 /readme.md
parentc27aa60c50c7ed7cb3e511c8a9def118541813e7 (diff)
downloadqmk_firmware-21df614a8ebf216f65822a28e319a05360f5244d.tar.gz
Branch point for 2019 Aug 30 Breaking Change
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/readme.md b/readme.md
index b08c675e4..203017834 100644
--- a/readme.md
+++ b/readme.md
@@ -7,6 +7,14 @@
[![GitHub contributors](https://img.shields.io/github/contributors/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/pulse/monthly)
[![GitHub forks](https://img.shields.io/github/forks/qmk/qmk_firmware.svg?style=social&label=Fork)](https://github.com/qmk/qmk_firmware/)
+# NOTICE: THIS IS A TESTING BRANCH
+
+This is the `breaking_changes` branch for Aug 2019. You can [read more in the tracking issue](https://github.com/qmk/qmk_firmware/issues/6146).
+
+We encourage you to try this branch out and see if there are any bugs. Our goal is to merge this branch to `master` on Aug 30. Please [report any bugs](https://github.com/qmk/qmk_firmware/issues/new?template=bug_report.md) you find.
+
+Original readme.md continues:
+
This is a keyboard firmware based on the [tmk\_keyboard firmware](https://github.com/tmk/tmk_keyboard) with some useful features for Atmel AVR and ARM controllers, and more specifically, the [OLKB product line](https://olkb.com), the [ErgoDox EZ](https://ergodox-ez.com) keyboard, and the [Clueboard product line](https://clueboard.co).
## Documentation