darkkirb/qmk_firmware
1
0
Fork 0
forked from mirrors/qmk_firmware
Code Issues Pull requests Projects Releases Packages Wiki Activity

Breaking Changes documentation fixes

Browse source
This commit is contained in:
James Young 2020-02-29 12:30:38 -08:00
parent 26eef35f07
commit cae91510dc
No known key found for this signature in database
GPG key ID: 06FAA77B63D48E80
2 changed files with 8 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
docs/breaking_changes.md
View file

@ -6,20 +6,21 @@ The breaking change period is when we will merge PR's that change QMK in dangero
## What has been included in past Breaking Changes? ## What has been included in past Breaking Changes?
* [2020 Feb 29](ChangeLog/20200229.md)
* [2019 Aug 30](ChangeLog/20190830.md) * [2019 Aug 30](ChangeLog/20190830.md)
## When is the next Breaking Change? ## When is the next Breaking Change?
The next Breaking Change is scheduled for February 29, 2020. The next Breaking Change is scheduled for May 30, 2020.
### Important Dates ### Important Dates
* [x] 2019 Sep 21 - `future` is created. It will be rebased weekly. * [x] 2019 Feb 29 - `future` is created. It will be rebased weekly.
* [x] 2020 Feb 1 - `future` closed to new PR's. * [ ] 2020 May 2 - `future` closed to new PR's.
* [x] 2020 Feb 1 - Call for testers. * [ ] 2020 May 2 - Call for testers.
* [x] 2020 Feb 27 - `master` is locked, no PR's merged. * [ ] 2020 May 28 - `master` is locked, no PR's merged.
* [ ] 2020 Feb 29 - Merge `future` to `master`. * [ ] 2020 May 30 - Merge `future` to `master`.
* [ ] 2020 Feb 29 - `master` is unlocked. PR's can be merged again. * [ ] 2020 May 30 - `master` is unlocked. PR's can be merged again.
## What changes will be included? ## What changes will be included?

6
readme.md
View file

@ -7,12 +7,6 @@
[![GitHub contributors](https://img.shields.io/github/contributors/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/pulse/monthly) [![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/) [![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 FUTURE BRANCH
Warning- This is the `future` 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). 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 ## Documentation