Skip to content

Commit

Permalink
doc: 更新README
Browse files Browse the repository at this point in the history
  • Loading branch information
@Mintimate
Mintimate committed Mar 8, 2024
1 parent 2087318 commit 6f26b91
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 18 deletions.
19 changes: 15 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
- [中文 - 繁體簡介](README_zh-CHT.md)
- [English - Brief](README_en.md)

一套快速初始化rime的模板，因为平时我使用`oh-my-zsh`，希望大家在用这个模板的时候，有种用`omz`的感觉；所以我给它取名叫`oh-my-rime`，你也可以叫它`薄荷输入法`，亦或者`Mint`。
一套快速初始化rime的模板，因为平时我使用`oh-my-zsh`，希望大家在用这个模板的时候，有种用`omz`的感觉；所以我给它取名叫`oh-my-rime`，你也可以叫它`薄荷输入法`，亦或者`Mint Input`。

如果你下载遇到困难，使用GitHub Action推送的镜像仓库：
- [oh-my-rime: https://gitlab.mintimate.cn/Mintimate/oh-my-rime](https://gitlab.mintimate.cn/Mintimate/oh-my-rime)
Expand All @@ -21,15 +21,22 @@ rime配置教程：

**强烈建议[配合文档](https://www.mintimate.cc)进行操作!!!**

本输入方案内包含： 『薄荷拼音』、『地球拼音-薄荷定制』和『98五笔-薄荷简版』，你可以在安装后，使用『Ctrl』+『~』进行切换。（默认激活的是『薄荷拼音』）。
本输入方案内包含：
- 薄荷拼音-全拼输入: 全拼输入，适合的人群最多，所以也是默认的输入；
- 小鹤双拼-薄荷定制: 基于小鹤双拼，添加定制内容。支持输入音形(形码)；
- 薄荷拼音-小鹤混输: 全拼输入的同时，支持小鹤双拼；
- 地球拼音-薄荷定制: 基于地球拼音，添加定制内容，扩展海量词库；
- 五笔九八-薄荷简版: 基于五笔98的精简版本，期待大家的PR。

你可以在安装后，使用『Ctrl』+『~』进行切换。（默认激活的是『薄荷拼音』）。

### 安装

以下教程，适用于Linux、macOS和Windows（Xp~）

0. 安装[Rime输入法](https://rime.im/)并注销或重启电脑；
1. 下载本仓库所有配置文件到本地rime配置文件；
2. 重新部署Rime（Windows、Linux可能需要配置分词依赖才可以使用EasyEN，参考：[EasyEn](https://github.com/BlindingDark/rime-easy-en)）
2. 重新部署Rime
3. 开始使用

## Tips
Expand Down Expand Up @@ -62,7 +69,7 @@ rime配置教程：

## 词库定制以及更新

本仓库的词库目录[dicts](dicts)，主要由：
本仓库的词库目录[dicts](dicts)，主要有：
- [雾凇拼音词库](https://github.com/iDvel/rime-ice)
- [98五笔词库](https://github.com/yanhuacuo/98wubi-tables)

Expand All @@ -75,11 +82,13 @@ dicts
├── rime_ice.41448.dict.yaml # 雾凇词库（GitHub action自动更新）
├── rime_ice.8105.dict.yaml # 雾凇词库（GitHub action自动更新）
├── rime_ice.base.dict.yaml # 雾凇词库（GitHub action自动更新）
├── rime_ice.ext.dict.yaml # 雾凇词库（GitHub action自动更新）
├── rime_ice.cn_en.txt # 雾凇词库（GitHub action自动更新）
├── rime_ice.en.dict.yaml # 雾凇词库（GitHub action自动更新）
├── rime_ice.en_ext.dict.yaml # 雾凇词库（GitHub action自动更新）
├── rime_ice.others.dict.yaml # 雾凇词库（GitHub action自动更新）
├── terra_pinyin_base.dict.yaml # 地球拼音自带词库
├── terra_pinyin_ext.dict.yaml # 地球拼音自带词库
├── terra_rime_ice.base.dict.yaml # 基于Python脚本自动转换雾凇并Action自动更新
└── wubi98_base.dict.yaml # 五笔基础词库
```
Expand All @@ -99,6 +108,7 @@ import_tables:
- dicts/rime_ice.8105 # 霧凇拼音 常用字集合
- dicts/rime_ice.41448 # 霧凇拼音 完整字集合
- dicts/rime_ice.base # 雾凇拼音 https://github.com/iDvel/rime-ice
- dicts/rime_ice.ext # 雾凇拼音 https://github.com/iDvel/rime-ice
- dicts/other_kaomoji # 颜文字表情（按`vv`呼出)
- dicts/other_emoji # Emoji(仅仅作为补充，实际使用一般是OpenCC生效)
- dicts/rime_ice.others # 雾凇拼音 others词库（用于自动纠错）
Expand All @@ -120,6 +130,7 @@ import_tables:
2. [Rime/小狼豪/鼠须管 输入法配置记](https://chenhe.me/post/oh-my-rime)
3. [rime-setting](https://github.com/Iorest/rime-setting)
4. [雾凇拼音 | 长期维护的简体词库](https://github.com/iDvel/rime-ice)
5. [rime-radical-pinyin | Rime 部件拆字输入方案（全拼双拼）](https://github.com/mirtlecn/rime-radical-pinyin)

## 推荐项目

Expand Down
16 changes: 14 additions & 2 deletions README_en.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,23 @@ You have a QQ account, you can join the group chat(No Ads!): 703260572

**It is strongly recommended to refer to the [documentation ↗](https://www.mintimate.cc) for operation!!!**

This input method package includes: "Mint Pinyin," "Earth Pinyin - Mint Custom," and "98 Wubi - Mint Lite." After installation, you can switch between them using "Ctrl" + "~" (The default active input method is "Mint Pinyin").
The input method scheme included:

- Mint Pinyin (薄荷拼音) - Full Spelling Input: Full spelling input, suitable for the largest population, so it's the default input method.
- Double Pinyin Fly( 小鹤双拼) - Mint Customized: Based on Double Pinyin Fly, with added customizations. Supports input of phonetic and shape (shape code) components.
- Mint Pinyin (薄荷拼音) - Xiaohe Mixed Input: Supports Double Pinyin Fly input while in full spelling input mode.
- Terra Pinyin - Mint Customized: Based on Terra Pinyin, with added customizations and extended massive word library.
- Wubi 98 - Mint Simplified: A simplified version based on Wubi 98, looking forward to your contributions.

You can switch between input methods by pressing "Ctrl" + "~" after installation. (Mint Pinyin is activated by default).

### Install

The following tutorials are available for Linux, macOS and Windows (Xp~)

0. Install [Rime Input Method](https://rime.im/) and log out or restart the computer;
1. Download all the configuration files of this warehouse to the local rime configuration file;
2. Redeploy Rime (Windows and Linux may need to configure word segmentation dependencies to use EasyEN, reference: [EasyEn](https://github.com/BlindingDark/rime-easy-en))
2. Redeploy Rime;
3. Get started

## Tips
Expand Down Expand Up @@ -75,11 +83,13 @@ dicts
├── rime_ice.41448.dict.yaml # Rime Ice dictionary (automatically updated by GitHub Action)
├── rime_ice.8105.dict.yaml # Rime Ice dictionary (automatically updated by GitHub Action)
├── rime_ice.base.dict.yaml # Rime Ice dictionary (automatically updated by GitHub Action)
├── rime_ice.ext.dict.yaml # Rime Ice dictionary (automatically updated by GitHub Action)
├── rime_ice.cn_en.txt # Rime Ice dictionary (automatically updated by GitHub Action)
├── rime_ice.en.dict.yaml # Rime Ice dictionary (automatically updated by GitHub Action)
├── rime_ice.en_ext.dict.yaml # Rime Ice dictionary (automatically updated by GitHub Action)
├── rime_ice.others.dict.yaml # Rime Ice dictionary (automatically updated by GitHub Action)
├── terra_pinyin_base.dict.yaml # Terra Pinyin default dictionary
├── terra_pinyin_ext.dict.yaml # Terra Pinyin default dictionary
├── terra_rime_ice.base.dict.yaml # Terra Rime Ice dictionary based on Python script conversion and automatic updating
└── wubi98_base.dict.yaml # 98 Wubi basic dictionary
```
Expand All @@ -99,6 +109,7 @@ import_tables:
- dicts/rime_ice.8105 # Rime Ice commonly used character collection
- dicts/rime_ice.41448 # Rime Ice complete character collection
- dicts/rime_ice.base # Rime Ice https://github.com/iDvel/rime-ice
- dicts/rime_ice.ext # Rime Ice https://github.com/iDvel/rime-ice
- dicts/other_kaomoji # Kaomoji (facial expressions) (activated by `vv`)
- dicts/other_emoji # Emoji (supplementary, actual usage usually requires OpenCC)
- dicts/rime_ice.others # Rime Ice others dictionary (used for automatic error correction)
Expand All @@ -123,6 +134,7 @@ import_tables:
2. [Rime/Xiaolanghao/Shuxuguan Input Method Configuration Notes](https://chenhe.me/post/oh-my-rime)
3. [rime-setting](https://github.com/Iorest/rime-setting)
4. [rime-ice | The long-term maintenance version of Simplified Chinese Characters](https://github.com/iDvel/rime-ice)
5. [rime-radical-pinyin | Rime Component-based Character Input Schemes (Full Spelling and Double Pinyin)](https://github.com/mirtlecn/rime-radical-pinyin)

## Other Recommended
- [98 Wubi, a very useful Wubi input program](http://www.98wubi.com/)
Expand Down
31 changes: 19 additions & 12 deletions README_zh-CHT.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
- [中文 - 繁體文檔](README_zh-CHT.md)
- [English - Documentation](README_en.md)

一套快速初始化rime的模闆，因為平時我使用`oh-my-zsh`，在使用rime時候，有種用`omz`的感覺；所以我給它取名叫`oh-my-rime`，妳也可以叫它`薄荷輸入法`，亦或者`Mint`。
一套快速初始化rime的模闆，因為平時我使用`oh-my-zsh`，在使用rime時候，有種用`omz`的感覺；所以我給它取名叫`oh-my-rime`，妳也可以叫它`薄荷輸入法`，亦或者`Mint Input`。

如果妳下載遇到睏難，使用GitHub Action推送的鏡像倉庫：
- [oh-my-rime: https://gitlab.mintimate.cn/Mintimate/oh-my-rime](https://gitlab.mintimate.cn/Mintimate/oh-my-rime)
Expand All @@ -21,15 +21,22 @@ rime配置教程：

**強烈建議[配合文檔](https://www.mintimate.cc)進行操作!!!**

本輸入方案內包含： 『薄荷拼音』、『地球拼音-薄荷定制』和『98五筆-薄荷簡版』，妳可以在安裝後，使用『Ctrl』+『~』進行切換。（預設激活的是『薄荷拼音』）。
本輸入方案內包含：
- 薄荷拼音-全拼輸入: 全拼輸入，適合的人群最多，所以也是預設的輸入；
- 小鶴雙拼-薄荷定制: 基於小鶴雙拼，添加定制內容。支援輸入音形(形碼)；
- 薄荷拼音-小鶴混輸: 全拼輸入的同時，支援小鶴雙拼；
- 地球拼音-薄荷定制: 基於地球拼音，添加定制內容，擴展海量詞庫；
- 五筆九八-薄荷簡版: 基於五筆98的精簡版本，期待大家的PR。

妳可以在安裝後，使用『Ctrl』+『~』進行切換。（預設激活的是『薄荷拼音』）。

### 安裝

以下教程，適用於Linux、macOS和Windows（Xp~）

0. 安裝[Rime輸入法](https://rime.im/)並註銷或重啟電腦；
1. 下載本倉庫所有配置文件到本地rime配置文件；
2. 重新部署Rime（Windows、Linux可能需要配置分詞依賴才可以使用EasyEN，參考：[EasyEn](https://github.com/BlindingDark/rime-easy-en)）　
2. 重新部署Rime
3. 開始使用

## Tips
Expand Down Expand Up @@ -61,7 +68,7 @@ rime配置教程：

## 詞庫定制以及更新

本倉庫的詞庫目錄[dicts](dicts)，主要由：
本倉庫的詞庫目錄[dicts](dicts)，主要有：
- [霧凇拼音詞庫](https://github.com/iDvel/rime-ice)
- [98五筆詞庫](https://github.com/yanhuacuo/98wubi-tables)

Expand All @@ -74,11 +81,13 @@ dicts
├── rime_ice.41448.dict.yaml # 霧凇詞庫（GitHub action自動更新）
├── rime_ice.8105.dict.yaml # 霧凇詞庫（GitHub action自動更新）
├── rime_ice.base.dict.yaml # 霧凇詞庫（GitHub action自動更新）
├── rime_ice.ext.dict.yaml # 霧凇詞庫（GitHub action自動更新）
├── rime_ice.cn_en.txt # 霧凇詞庫（GitHub action自動更新）
├── rime_ice.en.dict.yaml # 霧凇詞庫（GitHub action自動更新）
├── rime_ice.en_ext.dict.yaml # 霧凇詞庫（GitHub action自動更新）
├── rime_ice.others.dict.yaml # 霧凇詞庫（GitHub action自動更新）
├── terra_pinyin_base.dict.yaml # 地球拼音自帶詞庫
├── terra_pinyin_ext.dict.yaml # 地球拼音自帶詞庫
├── terra_rime_ice.base.dict.yaml # 基於Python腳本自動轉換霧凇併Action自動更新
└── wubi98_base.dict.yaml # 五筆基礎詞庫
```
Expand All @@ -98,6 +107,7 @@ import_tables:
- dicts/rime_ice.8105 # 霧凇拼音 常用字集合
- dicts/rime_ice.41448 # 霧凇拼音 完整字集合
- dicts/rime_ice.base # 霧凇拼音 https://github.com/iDvel/rime-ice
- dicts/rime_ice.ext # 霧凇拼音 https://github.com/iDvel/rime-ice
- dicts/other_kaomoji # 顏文字錶情（按`vv`呼出)
- dicts/other_emoji # Emoji(僅僅作為補充，實際使用一般是OpenCC生效)
- dicts/rime_ice.others # 霧凇拼音 others詞庫（用於自動糾錯）
Expand All @@ -106,29 +116,26 @@ import_tables:

------


------

## 支持
## 支援

- [Mintimate's Blog: https://www.mintimate.cn](https://www.mintimate.cn)
- [Mintimate的爱发电: 加入电圈，支持创造!](https://afdian.net/a/mintimate)
- [Mintimate的愛發電: 加入電圈，支援創造!](https://afdian.net/a/mintimate)
- [Bilibili：@Mintimate](https://space.bilibili.com/355567627)
- [Youtube：@Mintimate](https://www.youtube.com/channel/UCI7LLdUGNzkcKOE7grAqCoA)


## 參考/致謝

1. [Rime-RimeWithSchemata](https://github.com/rime/home/wiki/RimeWithSchemata)
2. [Rime/小狼豪/鼠須管 輸入法配置記](https://chenhe.me/post/oh-my-rime)
3. [rime-setting](https://github.com/Iorest/rime-setting)
4. [雾凇拼音 | 长期维护的简体词库](https://github.com/iDvel/rime-ice)
4. [霧凇拼音 | 長期維護的簡體詞庫](https://github.com/iDvel/rime-ice)
5. [rime-radical-pinyin | Rime 部件拆字輸入方案（全拼雙拼）](https://github.com/mirtlecn/rime-radical-pinyin)

## 推薦項目

- [98五筆，十分好用的五筆輸入方案](http://www.98wubi.com/)
- [霧凇拼音，很優秀的中文詞庫](https://github.com/iDvel/rime-ice)


## ⭐⭐⭐

<picture>
Expand Down

0 comments on commit 6f26b91

Please sign in to comment.