mirror of
https://github.com/Ajetski/corne-zmk-config.git
synced 2025-11-27 12:42:44 -10:00
update README.md
This commit is contained in:
parent
3927bd8e67
commit
5d8bac3fd6
49
README.md
49
README.md
@ -1,44 +1,19 @@
|
|||||||
# 睫毛外设 (Eyelash Peripherals) Corne ZMK Repository
|
- [中文](README.md)
|
||||||
|
- [English](README_EN.md)
|
||||||
|
|
||||||
**This keyboard is not the same as [foostan's Corne](https://github.com/foostan/crkbd). It will not work with standard `corne` firmware.**
|
# 睫毛外设 (Eyelash Peripherals) Corne ZMK 仓库
|
||||||
|
|
||||||

|
**该键盘与 [foostan's Corne](https://github.com/foostan/crkbd) 不同,无法与标准的 `corne` 固件兼容。**
|
||||||
|
|
||||||
If you need a 3D model of this keyboard, email `380465425@qq.com`.
|

|
||||||
|
|
||||||
## Instructions
|
如果您需要该键盘的 3D 模型,请发送电子邮件至 `380465425@qq.com`。
|
||||||
|
|
||||||
1. [Fork this repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo#forking-a-repository).
|
## 使用说明
|
||||||
2. [Click the **Actions** tab and make sure the workflow is enabled](https://docs.github.com/en/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/disabling-and-enabling-a-workflow#enabling-a-workflow).
|
|
||||||
3. Make sure the `eyelash_corne` project in [`config/west.yml`](config/west.yml) still works. The `boards/arm/eyelash_corne` folder will be downloaded from this URL.
|
|
||||||
4. If there is still a `boards/arm/eyelash_corne` folder in your fork, delete it.
|
|
||||||
|
|
||||||
**If you already have a ZMK config repository, [you can add this one as a module instead of forking](https://zmk.dev/docs/features/modules#building-with-modules).**
|
1. [叉取此仓库](https://docs.github.com/en/get-started/quickstart/fork-a-repo#forking-a-repository)。
|
||||||
|
2. [点击 **Actions** 选项卡,确保工作流已启用](https://docs.github.com/en/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/disabling-and-enabling-a-workflow#enabling-a-workflow)。
|
||||||
|
3. 确保 [`config/west.yml`](config/west.yml) 中的 `eyelash_corne` 项目仍然有效。`boards/arm/eyelash_corne` 文件夹将从此 URL 下载。
|
||||||
|
4. 如果您的叉取中仍存在 `boards/arm/eyelash_corne` 文件夹,请将其删除。
|
||||||
|
|
||||||
## Keymap Diagram
|
**如果您已经有 ZMK 配置仓库,[您可以将此作为模块添加,而不是叉取](https://zmk.dev/docs/features/modules#building-with-modules)。**
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
## Mouse Support
|
|
||||||
|
|
||||||
:warning: This repository defaults to an EXPERIMENTAL mouse movement branch which is slated for eventual merge into ZMK, but is not guaranteed to be stable. For more information, see [beta testing](https://zmk.dev/docs/features/modules#beta-testing) and [PR #2477](https://github.com/zmkfirmware/zmk/pull/2477).
|
|
||||||
|
|
||||||
If desired, edit your `config/west.yml` to switch back to `zmkfirmware`'s `main` branch:
|
|
||||||
|
|
||||||
```diff
|
|
||||||
diff --git a/config/west.yml b/config/west.yml
|
|
||||||
index ac30a68..70ad540 100644
|
|
||||||
--- a/config/west.yml
|
|
||||||
+++ b/config/west.yml
|
|
||||||
@@ -13,8 +13,8 @@ manifest:
|
|
||||||
url: https://github.com/a741725193/zmk-new_corne
|
|
||||||
revision: main
|
|
||||||
- name: zmk
|
|
||||||
- remote: petejohanson
|
|
||||||
- revision: feat/pointers-with-input-processors
|
|
||||||
+ remote: zmkfirmware
|
|
||||||
+ revision: main
|
|
||||||
import: app/west.yml
|
|
||||||
self:
|
|
||||||
path: config
|
|
||||||
```
|
|
||||||
24
README_EN.md
Normal file
24
README_EN.md
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
- [Chinese](README.md)
|
||||||
|
- [English](README_EN.md)
|
||||||
|
|
||||||
|
# 睫毛外设 (Eyelash Peripherals) Corne ZMK Repository
|
||||||
|
|
||||||
|
**This keyboard is not the same as [foostan's Corne](https://github.com/foostan/crkbd). It will not work with standard `corne` firmware.**
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
If you need a 3D model of this keyboard, email `380465425@qq.com`.
|
||||||
|
|
||||||
|
## Instructions
|
||||||
|
|
||||||
|
1. [Fork this repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo#forking-a-repository).
|
||||||
|
2. [Click the **Actions** tab and make sure the workflow is enabled](https://docs.github.com/en/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/disabling-and-enabling-a-workflow#enabling-a-workflow).
|
||||||
|
3. Make sure the `eyelash_corne` project in [`config/west.yml`](config/west.yml) still works. The `boards/arm/eyelash_corne` folder will be downloaded from this URL.
|
||||||
|
4. If there is still a `boards/arm/eyelash_corne` folder in your fork, delete it.
|
||||||
|
|
||||||
|
**If you already have a ZMK config repository, [you can add this one as a module instead of forking](https://zmk.dev/docs/features/modules#building-with-modules).**
|
||||||
|
|
||||||
|
## Keymap Diagram
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
@ -6,15 +6,13 @@ manifest:
|
|||||||
# See:
|
# See:
|
||||||
# - https://zmk.dev/docs/features/modules
|
# - https://zmk.dev/docs/features/modules
|
||||||
# - https://docs.zephyrproject.org/3.5.0/develop/west/manifest.html#projects
|
# - https://docs.zephyrproject.org/3.5.0/develop/west/manifest.html#projects
|
||||||
- name: petejohanson
|
|
||||||
url-base: https://github.com/petejohanson
|
|
||||||
projects:
|
projects:
|
||||||
- name: eyelash_corne
|
- name: eyelash_corne
|
||||||
url: https://github.com/a741725193/zmk-new_corne
|
url: https://github.com/a741725193/zmk-new_corne
|
||||||
revision: main
|
revision: main
|
||||||
- name: zmk
|
- name: zmk
|
||||||
remote: petejohanson
|
remote: zmkfirmware
|
||||||
revision: feat/pointers-with-input-processors
|
revision: main
|
||||||
import: app/west.yml
|
import: app/west.yml
|
||||||
self:
|
self:
|
||||||
path: config
|
path: config
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user