mirror of
https://github.com/zmkfirmware/zmk.git
synced 2026-03-20 04:55:20 -05:00
docs: remove new shield clean room warning (#3180)
This commit is contained in:
@@ -40,10 +40,6 @@ export const SplitInvisTabs = (props) => (
|
||||
|
||||
);
|
||||
|
||||
:::danger
|
||||
Before reading this section, it is **vital** that you read through our [clean room policy](../contributing/clean-room.md).
|
||||
:::
|
||||
|
||||
This guide will walk through the steps necessary to add ZMK support for a keyboard that uses an add-on MCU board (e.g. Pro Micro compatible) to provide the microprocessor.
|
||||
|
||||
The high level steps are:
|
||||
@@ -63,6 +59,15 @@ Many of the above files will differ depending on whether your keyboard is a unib
|
||||
After adding ZMK support for a basic shield using this guide, check the sidebar for guides on adding any additional features (such as encoders) that your keyboard has.
|
||||
It may be helpful to review the upstream [shields documentation](https://docs.zephyrproject.org/4.1.0/hardware/porting/shields.html#shields) to get a proper understanding of the underlying system before continuing.
|
||||
|
||||
:::info
|
||||
When writing your shield, please be aware of [licensing](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository):
|
||||
|
||||
- If you reference code or other items that are under a copyleft license (e.g. GNU GPLv2, used by QMK) as a reference, you must license your shield under a compatible copyleft license.
|
||||
- If you license anything under a copyleft license, it cannot be referenced by anyone working on ZMK (see our [clean room policy](../contributing/clean-room.md)).
|
||||
|
||||
We generally recommend licensing your shield under MIT, if you don't have a particular incentive to do otherwise.
|
||||
:::
|
||||
|
||||
## New ZMK Module Repository
|
||||
|
||||
The first step to creating the shield is to create a new ZMK module repository from a template.
|
||||
|
||||
Reference in New Issue
Block a user