ajet/corne-zmk-config
1
0
Fork 0
mirror of https://github.com/Ajetski/corne-zmk-config.git synced 2025-11-27 13:02:45 -10:00
Code Issues Packages Projects Releases Wiki Activity

docs: provide instructions

Browse Source
This commit is contained in:
honorless 2024-11-17 19:38:36 -05:00
parent 40dcc19ee7
commit 3ba7c4f028
No known key found for this signature in database
GPG Key ID: 1B48A311ABE8DA4D
1 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -1,6 +1,19 @@
if you need the 3D modle of this keyboard，you can connect me by Email。380465425@qq.com # 睫毛外设 (Eyelash Peripherals) Corne ZMK Repository
# 睫毛外设店 (Eyelash Peripherals) Corne
**This keyboard is not the same as [foostan's Corne](https://github.com/foostan/crkbd). It will not work with standard `corne` firmware.**
![Photo of Eyelash Peripherals Corne](https://ae01.alicdn.com/kf/Sa797fee25edd44248fbfdb0e13d44e00B.jpg)
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 ## Keymap Diagram