# corfu-english-helper

**Repository Path**: emacs-hub/corfu-english-helper

## Basic Information

- **Project Name**: corfu-english-helper
- **Description**: 此仓库是为了提升国内下载速度的镜像仓库，每日同步一次。 原始仓库：
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: https://github.com/manateelazycat/corfu-english-helper.git
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-05-26
- **Last Updated**: 2022-05-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## What is corfu-english-helper ?
corfu-english-helper is english writing assistant, help me complete English word.

This plugin base on fantastic completion framework [Corfu](https://github.com/minad/corfu)

<img src="./screenshot.png" width="400">

## Install
1. Download corfu-english-helper:

```Bash
git clone --depth=1 -b master https://github.com/manateelazycat/corfu-english-helper.git ~/.emacs.d/site-lisp/corfu-english-helper/
```

2. Add corfu-english-helper to ```load-path```:
```Elisp
(add-to-list 'load-path "~/.emacs.d/site-lisp/corfu-english-helper/")
(require 'corfu-english-helper)
```

## Usage
* ```toggle-corfu-english-helper```: toggle on english helper, write english on the fly.
* ```corfu-english-helper-search```: popup english helper manually


## Customize your own dictionary.
Default english dictionary is generate from stardict KDict dictionary with below command

```Shell
python ./stardict.py stardict-kdic-ec-11w-2.4.2/kdic-ec-11w.ifo
```

You can replace with your favorite stardict dictionary's info filepath to generate your own corfu-english-helper-data.el .

# Acknowledgements
I create [company-english-helper](https://github.com/manateelazycat/company-english-helper), this package is port to corfu-mode, most code of corfu version is written by [theFool32](https://github.com/theFool32).