summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJames Young <18669334+noroadsleft@users.noreply.github.com>2021-02-27 12:54:23 -0800
committerJames Young <18669334+noroadsleft@users.noreply.github.com>2021-02-27 12:54:23 -0800
commitc7a7982e23322ca9e45a44550b80b09a959477eb (patch)
tree2dbc60aec18d8f686a11d262e4418332c22bca6b
parent1a5f6b54aff179732e3f4f4eb79e47454f0a1eb5 (diff)
downloadqmk_firmware-c7a7982e23322ca9e45a44550b80b09a959477eb.tar.gz
qmk_firmware-c7a7982e23322ca9e45a44550b80b09a959477eb.zip
Branch point for 2021 May 29 Breaking Change
-rw-r--r--readme.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/readme.md b/readme.md
index 6092f209be..bb85115af4 100644
--- a/readme.md
+++ b/readme.md
@@ -9,6 +9,12 @@
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).
+# 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
+
## Documentation
* [See the official documentation on docs.qmk.fm](https://docs.qmk.fm)