refactor: Move to new zmk.dev domain name.
Peter Johanson
Pete Johanson
parent
ba45aaa81b
commit
3f4839ec96
|
|
@ -60,7 +60,7 @@ representative at an online or offline event.
|
|||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported to the community leaders responsible for enforcement at
|
||||
conduct@zmkfirmware.dev.
|
||||
conduct@zmk.dev.
|
||||
All complaints will be reviewed and investigated promptly and fairly.
|
||||
|
||||
All community leaders are obligated to respect the privacy and security of the
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ you have any questions, please come join us on the
|
|||
## Code of Conduct
|
||||
|
||||
All community members are expected to abide by the [Code of Conduct][code-of-conduct].
|
||||
For any and all conduct inquiries or concerns, please contact conduct@zmkfirmware.dev.
|
||||
For any and all conduct inquiries or concerns, please contact conduct@zmk.dev.
|
||||
|
||||
[code-of-conduct]: https://github.com/zmkfirmware/zmk/blob/main/CODE_OF_CONDUCT.md
|
||||
|
||||
|
|
@ -35,8 +35,8 @@ ZMK project.
|
|||
|
||||
### Before Submitting a Report
|
||||
|
||||
- Review the [Frequently Asked Questions](https://zmkfirmware.dev/docs/faq).
|
||||
- Check the [Troubleshooting Guide](https://zmkfirmware.dev/docs/troubleshooting) for answers.
|
||||
- Review the [Frequently Asked Questions](https://zmk.dev/docs/faq).
|
||||
- Check the [Troubleshooting Guide](https://zmk.dev/docs/troubleshooting) for answers.
|
||||
- Search the [open issues](https://github.com/zmkfirmware/zmk/issues) for an existing report that
|
||||
matches your problem.
|
||||
|
||||
|
|
@ -47,10 +47,10 @@ To open a report:
|
|||
- Head to https://github.com/zmkfirmware/zmk/issues/new
|
||||
- Provide an accurate summary of the issue in the title.
|
||||
- Provide as much detail as you can about the issue including:
|
||||
- What [board/shield](https://zmkfirmware.dev/docs/faq#what-is-a-board) you are using.
|
||||
- What [board/shield](https://zmk.dev/docs/faq#what-is-a-board) you are using.
|
||||
- A link to the user repository, if you used it to build your firmware.
|
||||
- Exact steps to reproduce the problem.
|
||||
- Any relevant screenshots or [logs](https://zmkfirmware.dev/docs/dev-guide-usb-logging)
|
||||
- Any relevant screenshots or [logs](https://zmk.dev/docs/dev-guide-usb-logging)
|
||||
|
||||
## Testing
|
||||
|
||||
|
|
@ -91,7 +91,7 @@ You can setup git to run prettier automatically when you commit by installing th
|
|||
### Development Setup
|
||||
|
||||
To get your development environment setup going, start at the
|
||||
[basic setup](https://zmkfirmware.dev/docs/dev-setup) docs, and make sure you can build and flash
|
||||
[basic setup](https://zmk.dev/docs/dev-setup) docs, and make sure you can build and flash
|
||||
your own locally built firmware.
|
||||
|
||||
### Formatting
|
||||
|
|
@ -124,4 +124,4 @@ When opening a pull request with your changes, please:
|
|||
- Requested testing by reviewers or testers.
|
||||
- Screenshots or logs that support understanding the change.
|
||||
|
||||
[discord-invite]: https://zmkfirmware.dev/community/discord/invite
|
||||
[discord-invite]: https://zmk.dev/community/discord/invite
|
||||
|
|
|
|||
10
README.md
10
README.md
|
|
@ -1,13 +1,13 @@
|
|||
# Zephyr™ Mechanical Keyboard (ZMK) Firmware
|
||||
|
||||
[](https://zmkfirmware.dev/community/discord/invite)
|
||||
[](https://zmk.dev/community/discord/invite)
|
||||
[](https://github.com/zmkfirmware/zmk/actions)
|
||||
[](CODE_OF_CONDUCT.md)
|
||||
|
||||
[ZMK Firmware](https://zmkfirmware.dev/) is an open source (MIT) keyboard firmware built on the [Zephyr™ Project](https://www.zephyrproject.org/) Real Time Operating System (RTOS). ZMK's goal is to provide a modern, wireless, and powerful firmware free of licensing issues.
|
||||
[ZMK Firmware](https://zmk.dev/) is an open source (MIT) keyboard firmware built on the [Zephyr™ Project](https://www.zephyrproject.org/) Real Time Operating System (RTOS). ZMK's goal is to provide a modern, wireless, and powerful firmware free of licensing issues.
|
||||
|
||||
Check out the website to learn more: https://zmkfirmware.dev/
|
||||
Check out the website to learn more: https://zmk.dev/
|
||||
|
||||
You can also come join our [ZMK Discord Server](https://zmkfirmware.dev/community/discord/invite)
|
||||
You can also come join our [ZMK Discord Server](https://zmk.dev/community/discord/invite)
|
||||
|
||||
To review features, check out the [feature overview](https://zmkfirmware.dev/docs/). ZMK is under active development, and new features are listed with the [enhancement label](https://github.com/zmkfirmware/zmk/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement) in GitHub. Please feel free to add 👍 to the issue description of any requests to upvote the feature.
|
||||
To review features, check out the [feature overview](https://zmk.dev/docs/). ZMK is under active development, and new features are listed with the [enhancement label](https://github.com/zmkfirmware/zmk/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement) in GitHub. Please feel free to add 👍 to the issue description of any requests to upvote the feature.
|
||||
|
|
|
|||
|
|
@ -16,16 +16,16 @@ Hacktoberfest activity, and a current open call for community feedback on a ZMK
|
|||
|
||||
So much going on in ZMK!
|
||||
|
||||
- Added a new generic [Hold Tap behavior](https://zmkfirmware.dev/docs/behaviors/hold-tap)
|
||||
- Added a new generic [Hold Tap behavior](https://zmk.dev/docs/behaviors/hold-tap)
|
||||
in [#146](https://github.com/zmkfirmware/zmk/pull/146) which now powers mod-tap, layer-tap, etc. - [okke-formsma]
|
||||
- [BLE profile/connection management](https://zmkfirmware.dev/docs/behaviors/bluetooth)
|
||||
- [BLE profile/connection management](https://zmk.dev/docs/behaviors/bluetooth)
|
||||
in [#133](https://github.com/zmkfirmware/zmk/pull/133) - [petejohanson]
|
||||
- Integration tests were added to automate testing of behaviors in [#131](https://github.com/zmkfirmware/zmk/pull/131) by [BrainWart] & [petejohanson]
|
||||
- [Toggle layer behavior](https://zmkfirmware.dev/docs/behaviors/layers#toggle-layer), e.g. `&tog LOWER`, in
|
||||
- [Toggle layer behavior](https://zmk.dev/docs/behaviors/layers#toggle-layer), e.g. `&tog LOWER`, in
|
||||
[#98](https://github.com/zmkfirmware/zmk/pull/98) - [BrainWart]
|
||||
- Key fix for dropped press/release over HID [#93](https://github.com/zmkfirmware/zmk/pull/93)/[#96](https://github.com/zmkfirmware/zmk/pull/96) - [careyk007](https://github.com/careyk007) & [petejohanson]
|
||||
- Code formatting standardized using `clang-format` in [#183](https://github.com/zmkfirmware/zmk/pull/183) - [petejohanson]
|
||||
- [Bootloader reset behavior](https://zmkfirmware.dev/docs/behaviors/reset#bootloader-reset), e.g. `&bootloader`, in [#116](https://github.com/zmkfirmware/zmk/pull/116) - [petejohanson]
|
||||
- [Bootloader reset behavior](https://zmk.dev/docs/behaviors/reset#bootloader-reset), e.g. `&bootloader`, in [#116](https://github.com/zmkfirmware/zmk/pull/116) - [petejohanson]
|
||||
- Various bug fixes and documentation
|
||||
|
||||
## New Shields
|
||||
|
|
|
|||
|
|
@ -82,7 +82,7 @@ Currently, ZMK only supports wireless split, but wired split is possible and we
|
|||
|
||||
### What bootloader does ZMK use?
|
||||
|
||||
ZMK isn’t designed for any particular bootloader, and supports flashing different boards with different flash utilities (e.g. OpenOCD, nrfjprog, etc.). So if you have any difficulties, please let us know on [Discord](https://zmkfirmware.dev/community/discord/invite)!
|
||||
ZMK isn’t designed for any particular bootloader, and supports flashing different boards with different flash utilities (e.g. OpenOCD, nrfjprog, etc.). So if you have any difficulties, please let us know on [Discord](https://zmk.dev/community/discord/invite)!
|
||||
|
||||
### Can I contribute?
|
||||
|
||||
|
|
@ -90,11 +90,11 @@ Of course! Please use the developer [documentation](/docs) to get started!
|
|||
|
||||
### I have an idea! What should I do?
|
||||
|
||||
Please join us on [Discord](https://zmkfirmware.dev/community/discord/invite) and discuss it with us!
|
||||
Please join us on [Discord](https://zmk.dev/community/discord/invite) and discuss it with us!
|
||||
|
||||
### I want to add a new keyboard! What should I do?
|
||||
|
||||
The exact process for the management of all the possible hardware is still being finalized, but any developer looking to contribute new keyboard definitions should chat with us on [Discord](https://zmkfirmware.dev/community/discord/invite) to get started.
|
||||
The exact process for the management of all the possible hardware is still being finalized, but any developer looking to contribute new keyboard definitions should chat with us on [Discord](https://zmk.dev/community/discord/invite) to get started.
|
||||
|
||||
### Does ZMK have a Code of Conduct?
|
||||
|
||||
|
|
|
|||
|
|
@ -49,7 +49,7 @@ In addition to the basic keyboard functionality, there is some initial support f
|
|||
- OLEDs
|
||||
- RGB Underglow
|
||||
|
||||
Until detailed documentation is available, feel free to ask questions about how these are supported in the [Discord server](https://zmkfirmware.dev/community/discord/invite).
|
||||
Until detailed documentation is available, feel free to ask questions about how these are supported in the [Discord server](https://zmk.dev/community/discord/invite).
|
||||
|
||||
## Contributing
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ sidebar_title: Troubleshooting
|
|||
|
||||
### Summary
|
||||
|
||||
The following page provides suggestions for common errors that may occur during firmware compilation. If the information provided is insufficient to resolve the issue, feel free to seek out help from the [ZMK Discord](https://zmkfirmware.dev/community/discord/invite).
|
||||
The following page provides suggestions for common errors that may occur during firmware compilation. If the information provided is insufficient to resolve the issue, feel free to seek out help from the [ZMK Discord](https://zmk.dev/community/discord/invite).
|
||||
|
||||
### File Transfer Error
|
||||
|
||||
|
|
|
|||
|
|
@ -68,21 +68,21 @@ values={[
|
|||
<TabItem value="curl">
|
||||
|
||||
```
|
||||
bash -c "$(curl -fsSL https://zmkfirmware.dev/setup.sh)"
|
||||
bash -c "$(curl -fsSL https://zmk.dev/setup.sh)"
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="wget">
|
||||
|
||||
```
|
||||
bash -c "$(wget https://zmkfirmware.dev/setup.sh -O -)" '' --wget
|
||||
bash -c "$(wget https://zmk.dev/setup.sh -O -)" '' --wget
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="PowerShell">
|
||||
|
||||
```
|
||||
iex ((New-Object System.Net.WebClient).DownloadString('https://zmkfirmware.dev/setup.ps1'))
|
||||
iex ((New-Object System.Net.WebClient).DownloadString('https://zmk.dev/setup.ps1'))
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ const path = require("path");
|
|||
module.exports = {
|
||||
title: "ZMK Firmware",
|
||||
tagline: "Modern, open source keyboard firmware",
|
||||
url: "https://zmkfirmware.dev",
|
||||
url: "https://zmk.dev",
|
||||
baseUrl: "/",
|
||||
favicon: "img/favicon.ico",
|
||||
organizationName: "zmkfirmware", // Usually your GitHub org/user name.
|
||||
|
|
@ -70,7 +70,7 @@ module.exports = {
|
|||
{
|
||||
label: "Discord",
|
||||
href:
|
||||
(process.env.URL || "https://zmkfirmware.dev") +
|
||||
(process.env.URL || "https://zmk.dev") +
|
||||
"/community/discord/invite",
|
||||
},
|
||||
{
|
||||
|
|
|
|||
Loading…
Reference in New Issue