summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJames Young <18669334+noroadsleft@users.noreply.github.com>2020-11-29 10:54:29 -0800
committerJames Young <18669334+noroadsleft@users.noreply.github.com>2020-11-30 03:29:39 -0800
commit3cc7d22732e201d5fd83931e5cfee21f83fd2352 (patch)
treefb47ec0abc8e990a784c4d3b524411ede32ba1b8
parent990d5189d19341cb768ea39a5510f381f1522e20 (diff)
Branch point for 2021 Feb 27 Breaking Change
-rw-r--r--readme.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/readme.md b/readme.md
index 6092f209be..6321681a92 100644
--- a/readme.md
+++ b/readme.md
@@ -7,6 +7,12 @@
[![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/)
+# THIS IS THE DEVELOP BRANCH
+
+Warning- This is the `develop` branch of QMK Firmware. You may encounter broken code here. Please see [Breaking Changes](https://docs.qmk.fm/#/breaking_changes) for more information.
+
+# Original readme 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