diff --git a/.gitignore b/.gitignore index ecc4140..3d7973c 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,6 @@ +design/ + + GALLERY.md # Created by .ignore support plugin (hsz.mobi) diff --git a/README.md b/README.md index 2de2ed3..2506b2b 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,11 @@ *Make CapsLock Great Again!* [![Visits Badge](https://badges.pufler.dev/visits/Vonng/Capslock)](https://badges.pufler.dev) -[![](images/logo.svg)](http://capslock.vonng.com) +![](docs/img/logo.svg) *Transform ⇪CapsLock into a powerful **modifier** **✱ Hyper** that miraculously increases your work productivity!* -[**Capslock Website**](http://capslock.vonng.com/en/) / [**ZH Site**](http://capslock.vonng.com/zh/) - -[**Chinese Documentation 中文文档** ](README_ZH.md) +[**zh-cn docs 中文文档** ](README_ZH.md) [**Karabiner-Elements Official Gallery**](https://ke-complex-modifications.pqrs.org/#emulation-modes) @@ -57,7 +55,7 @@ Capslock serves via [**Karabiner-Elements**](https://karabiner-elements.pqrs.or Or just open this link with Safari to launch karabiner and load config from URL: ```yaml - karabiner://karabiner/assets/complex_modifications/import?url=https://vonng.com/capslock.json + karabiner://karabiner/assets/complex_modifications/import?url=https://github.com/Vonng/Capslock/blob/master/mac_v3/capslock.json ``` Or check karabiner official [gallery](https://ke-complex-modifications.pqrs.org/#emulation-modes) and load it there. @@ -70,7 +68,7 @@ Capslock serves via [**Karabiner-Elements**](https://karabiner-elements.pqrs.or Capslock works on **ANSI** keyboards and similar layouts. It literally remaps every [**keys**](#Symbols) on the keyboard. Including 10 categories. -![](images/keyboard.png) +![](docs/img/keyboard.png) > **[Control Planes](#Control-Planes)** are defined by combination of four extra left modifiers: ⌘⌥⌃⇧.This image shows the layout of control plane 0. @@ -107,7 +105,7 @@ Hold **✱ Hyper** to enable hyper functionalities. We will assume a * Hold additional ⌘ Command for **selection**. (like holding ⇧shift in normal), additional ⌥ Option for **word/para selection**. * Hold additional ⇧ Shift for **app/win/tab switching**. Hold additional ⌃ Control for **desktop management** . * Hold additional ⌥ Option for 🖱️ **mouse move**. Add ⇧shift to **⏫ accelerate**. (U, I, O, P maps to mouse buttons) . -* ⇧⌥ turns navigator to **🖲️ mouse wheel**, and ⇧⌘ is the ⏫ **accelerated** version . `HJKL` for wheel, wihle `UIOP` for reversed wheel move. +* ⇧⌥ turns navigator to **🖲️ mouse wheel**, and ⇧⌘ is the ⏫ **accelerated** version . `HJKL` for wheel, while `UIOP` for reversed wheel move. | Feature | **Move** | **Select** | **WordSel** | **Window** | **Desktop** | 🖱️ | **🖱️⏫** | 🖲️ | 🖲️⏫ | | :-----: | :------: | :--------: | :---------: | :--------: | :---------: | :--: | :----: | :--: | :--: | @@ -128,7 +126,7 @@ Hold **✱ Hyper** to enable hyper functionalities. We will assume a * Arrows ←↓↑→ to 🖱️ **mouse** actions too. Hold ⌥ Option to ⏬ **slow down**, hold ⌘ Command to ⏫ **speed up**. * Hold ⇧ Shift turns to 🖲️ **wheel move**. Extra ⌥ Option to ⏬ **slow down**, extra ⌘ Command to ⏫ **speed up**. -* ↩ Return maps to left **click**. And additional ⌘⌥⌃⇧ turns into right click, middle click, backward, forward. +* ↩ Return maps to left **click**. Additional ⌘⌥⌃⇧ turns into right click, middle click, backward, forward. | Feature | 🖱️ | 🖱️⏬ | 🖱️⏫ | 🖲️ | 🖲️⏬ | 🖲️⏫ | | :---------: | :----------: | :-------: | :-------: | :--------: | :-------: | :-------: | @@ -194,7 +192,7 @@ Hold **✱ Hyper** to enable hyper functionalities. We will assume a app shortcuts * E R T Y F G are used as application shortcuts. (yellow area) -* Popular apps and dev tools are registed to 3 default planes: ✱/⌘/⌥. Assign these shortcuts according to your own needs. +* Popular apps and dev tools are registered to 3 default planes: ✱/⌘/⌥. Assign these shortcuts according to your own needs. | Key\Mod | ✱ | ⌘ | ⌥ | | :-----: | :----------------: | :-------: | :---------: | @@ -212,7 +210,7 @@ Hold **✱ Hyper** to enable hyper functionalities. We will assume a
terminal control -D, Z, X, C, V, B are used as terminal control keys. Sending singals and IDE commands. (green area) +D, Z, X, C, V, B are used as terminal control keys. Sending singles and IDE commands. (green area) | Key\Mod | ✱ | ⌘ | | :-----: | :------------------------------------------------: | :------------------: | @@ -363,12 +361,12 @@ Capslock serves via [**Karabiner-Elements**](https://karabiner-elements.pqrs.or # Capslock Official Site (v3) karabiner://karabiner/assets/complex_modifications/import?url=https://vonng.com/capslock.json - # Karabiner-Elements Offical Script Gallery (v3) + # Karabiner-Elements Official Script Gallery (v3) karabiner://karabiner/assets/complex_modifications/import?url=https://pqrs.org/osx/karabiner/complex_modifications/json/caps_lock_enhancement.json ``` 3. Launch Karabiner-Elements. **Tab: ComplexModification** → **Button: Add Rules**, then enabled rulesets. - ![](mac_v3/images/config-karabiner.png) + ![](mac_v3/docs/img/config-karabiner.png)
@@ -396,7 +394,7 @@ Capslock serves via [**AutoHotKey**](https://www.autohotkey.com/) on Windows. #### Q: What's new in V3? -**A**: The original v2 only use 1 ~ 3 control planes. While v3 uses up to 9 control planes. A large number of functions have been added to make the additional modifier ⌘⌥⌃⇧ functioning in a reasonable way. +**A**: The original v2 only use 1 ~ 3 control planes. While v3 uses up to 9 control planes. Numerous functions have been added to make the additional modifier ⌘⌥⌃⇧ functioning reasonably. #### Q: Is there any incompatible changes in V3 compare to V2 ? @@ -417,7 +415,7 @@ Capslock serves via [**AutoHotKey**](https://www.autohotkey.com/) on Windows. #### Q: Why is there an older version in MacOS? -**A**: There was an older version of Karabiner that used XML config. Apple modified it's kernel architecture in MacOS Sierra (10.12) and many programs had to be overhauled. So then there was a new version of Karabiner, the Karabiner-Elements, which is still in use today. +**A**: There was an older version of Karabiner that used XML config. Apple modified its kernel architecture in MacOS Sierra (10.12) and many programs had to be overhauled. So then there was a new version of Karabiner, the Karabiner-Elements, which is still in use today. #### Q: How can I customize it to my needs? @@ -425,7 +423,7 @@ Capslock serves via [**AutoHotKey**](https://www.autohotkey.com/) on Windows. #### Q: Is this original? -**A**: I'm the first one to make a capslock overhaul schema as far as I know. The original win AHK version was wrote in 2013. The first mac version was wrote in 2015. It is the first capslock emulation schema in karabiner's [gallary](https://ke-complex-modifications.pqrs.org/#emulation-modes). +**A**: I'm the first one to make a capslock overhaul schema as far as I know. The original win AHK version was wrote in 2013. The first mac version was wrote in 2015. It is the first capslock emulation schema in karabiner's [gallery](https://ke-complex-modifications.pqrs.org/#emulation-modes). diff --git a/README_ZH.md b/README_ZH.md index 5b371b2..4d5c370 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -2,7 +2,7 @@ *让Capslock再次伟大！* [![Visits Badge](https://badges.pufler.dev/visits/Vonng/Capslock)](https://badges.pufler.dev) -![](images/logo.svg) +![](docs/img/logo.svg) 将 ⇪CapsLock（大写锁定键）改造为一个强力的**功能修饰键（✱ Hyper ）**，奇迹般地提高操作效率与生产力。 @@ -63,7 +63,7 @@ Capslock以**ANSI**布局键盘为蓝本，对Capslock之外的 [**所有按键**](#符号) 进行了功能定制与修饰，主要分为10大类功能。 -![](mac_v3/images/keyboard.png) +![](mac_v3/docs/img/keyboard.png) > [**控制平面**](控制平面) 由左侧修饰键的排列组合所定义：根据 ⌘⌥⌃⇧的状态，最多有16个额外的控制平面。上图为0号控制平面布局。 @@ -316,7 +316,7 @@ Capslock以**ANSI**布局键盘为蓝本，对Capslock之外的 [**所有按键* 3. 打开Karabiner-Elements，切至第三标签页`ComplexModification`，点击左下方按钮 `Add Rules`按需启用Capslock预置规则即可。 - ![](mac_v3/images/config-karabiner.png) + ![](mac_v3/docs/img/config-karabiner.png) ### Windows安装 @@ -384,7 +384,7 @@ V3在整体上采用前向兼容策略，但确实有三个地方进行了不兼 大部分能搜索到的Capslock方案，特别是基于Karabiner与AutoHotKey的改造基本都能看到这里的影子。 -这个配置也是Karabiner官方[Gallary](https://ke-complex-modifications.pqrs.org/#emulation-modes)收录的第一个Capslock全面改造方案， +这个配置也是Karabiner官方[Gallery](https://ke-complex-modifications.pqrs.org/#emulation-modes)收录的第一个Capslock全面改造方案， 最近我倒是发现一些Fork不讲武德，卖钱也不署名来源，所以开源协议从WTFPL修改为Apache License 2.0。卖钱虽好，但还是要尊重一下原作者，至少保留个署名吧？ diff --git a/images/config-karabiner.png b/docs/img/config-karabiner.png similarity index 100% rename from images/config-karabiner.png rename to docs/img/config-karabiner.png diff --git a/images/keyboard.png b/docs/img/keyboard.png similarity index 100% rename from images/keyboard.png rename to docs/img/keyboard.png diff --git a/images/logo.png b/docs/img/logo.png similarity index 100% rename from images/logo.png rename to docs/img/logo.png diff --git a/images/logo.svg b/docs/img/logo.svg similarity index 100% rename from images/logo.svg rename to docs/img/logo.svg diff --git a/images/trump.jpg b/images/trump.jpg deleted file mode 100644 index a56e032..0000000 Binary files a/images/trump.jpg and /dev/null differ