Skip to content

Commit

Permalink
Some README adjustments and release preparation for Ver 1.3.
Browse files Browse the repository at this point in the history
  • Loading branch information
kiyoka committed May 4, 2023
1 parent fc9043b commit c48c677
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 16 deletions.
2 changes: 1 addition & 1 deletion FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ A. ローマ字の文章の代わりに、英語の文章の最後でCtrl-Jを

## Q. GPTを使っているなら、長文の要約もできそうです。どのようにすれば要約ができますか?

A. Sumibi 1.1 では、まだ長文の要約をサポートしていません。将来バージョンでサポート予定です。
A. Sumibi Ver 1.3 では、まだ長文の要約をサポートしていません。将来バージョンでサポート予定です。

## Q. OpenAIからの応答が遅い場合があります。タイムアウトを短くすることはできますか?

Expand Down
41 changes: 28 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,17 @@

Japanese input method powered by ChatGPT API

![image.png](./images/sumibi_image.jpg)

## Sumibiとは

Emacs用の日本語入力システム(IME)です。

Sumibiはモードレスです。
日本語入力モードに切り替えることなく日本語を入力できます。

日本語と英語の相互翻訳もサポートしていますので、英語で文章を書くことが多い人にもおすすめです。

よくある質問はこちら。[FAQ](FAQ.md)

## 利用可能なEmacsバージョン
Expand Down Expand Up @@ -44,26 +48,17 @@ Emacsを再起動するとSumibiがステータスバーに表示されます。
[gpt-3.5-turbo] はOpenAI API 呼び出しで使用しているGPTのモデルです。
![image.png](./images/img_9.png)

## 変換方法
## ローマ字や英語の文章から日本語への変換

1. ローマ字で書いた文章の最後にカーソルを合わせて、Ctrl-J を入力すると日本語の文章に置き換わります。
![image.png](./images/img_15.png)
![image.png](./images/img_16.png)
2. 変換結果が気に入らない場合は、そのまま Ctrl-J を入力すると変換候補のポップアップが表示されるので、その中から選択できます。
![image.png](./images/img_11.png)

## Undo

変換結果が気に入らない時は、ESC-u キーを入力することでUndoできます。

または、変換結果に原文ままの選択肢がありますので「原文まま」を選択します。
![image.png](./images/img_10.png)

## 英語から日本語への変換

英語の文章の最後にカーソルを合わせて、Ctrl-J を入力すると、日本語の文章に変換されます。
![image.png](./images/img_13.png)
![image.png](./images/img_14.png)
3. 英語の文章の最後にカーソルを合わせて、Ctrl-J を入力すると、日本語の文章に変換されます。
![image.png](./images/img_13.png)
![image.png](./images/img_14.png)


## 日本語から英語への翻訳
Expand All @@ -72,6 +67,13 @@ Emacsを再起動するとSumibiがステータスバーに表示されます。

「ESC を押してから j」は、代わりに ALT+j でも入力可能です。

## Undo

変換結果が気に入らない時は、ESC-u キーを入力することでUndoできます。

または、変換結果に原文ままの選択肢がありますので「原文まま」を選択します。
![image.png](./images/img_10.png)

# History

### Ver 1.0.0
Expand All @@ -90,3 +92,16 @@ Emacsを再起動するとSumibiがステータスバーに表示されます。
* OSSの名前をSumibiGPTからSumibiに変更した。
* sumibigpt.elをsumibi.elに変更した。
* 英語への翻訳機能を実装した。

### Ver 1.3.0

* markdown形式的な英語のドキュメントを一括で翻訳する際、以下のmarkdown syntaxが壊れないように対策した。(nameとsentenceの部分だけが日本語に翻訳される)

```
[name](URL)
![name](URL)
# sentence
## sentence
### sentence
#### sentence
```
4 changes: 2 additions & 2 deletions emacs/sumibi.el
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
;; Copyright (C) 2023 Kiyoka Nishiyama
;;
;; Author: Kiyoka Nishiyama <[email protected]>
;; Version: 1.2.0 ;;SUMIBI-VERSION
;; Version: 1.3.0 ;;SUMIBI-VERSION
;; Keywords: ime, japanese
;; Package-Requires: ((cl-lib "1.0") (popup "0.5.9") (unicode-escapeo "20230109.1222"))
;; URL: https://github.com/kiyoka/Sumibi
Expand Down Expand Up @@ -1273,7 +1273,7 @@ point から行頭方向に同種の文字列が続く間を漢字変換しま
(setq default-input-method "japanese-sumibi")

(defconst sumibi-version
"1.2.0" ;;SUMIBI-VERSION
"1.3.0" ;;SUMIBI-VERSION
)
(defun sumibi-version (&optional arg)
"入力モード変更"
Expand Down

0 comments on commit c48c677

Please sign in to comment.