From 66716632ba42f26fc9c976af10ccfc691d867014 Mon Sep 17 00:00:00 2001 From: David Ye Date: Sat, 11 Mar 2023 22:51:48 -0800 Subject: [PATCH] Improving the READMEs (#152) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * remove the duplicate item [13,17] => [17] in README * correct the item numbers in README * fix typo * add 示范用例 section title to match the English README --------- Co-authored-by: yihong0618 --- README-CN.md | 3 ++- README.md | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/README-CN.md b/README-CN.md index 258c41b..349c1f6 100644 --- a/README-CN.md +++ b/README-CN.md @@ -43,7 +43,8 @@ bilingual_book_maker 是一个 AI 翻译工具，使用 ChatGPT 帮助用户制 17. 如果出现了错误或使用 `CTRL+C` 中断命令，不想接下来继续翻译了，会生成一本 ${book_name}_bilingual_temp.epub 的书，直接改成你想要的名字就可以了 18. 如果你想要翻译电子书中的无标签字符串，可以使用 `--allow_navigable_strings` 参数，会将可遍历字符串加入翻译队列，**注意，在条件允许情况下，请寻找更规范的电子书** -e.g. +### 示范用例 + ```shell # 如果你想快速测一下 python3 make_book.py --book_name test_books/animal_farm.epub --openai_key ${openai_key} --test diff --git a/README.md b/README.md index 297f2ca..f30d000 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ The bilingual_book_maker is an AI translation tool that uses ChatGPT to assist u 17. If there are any errors or you wish to interrupt the translation by pressing `CTRL+C`. A book named `${book_name}_bilingual_temp.epub` would be generated. You can simply rename it to any desired name. 18. If you want to translate strings in an e-book that aren't labeled with any tags, you can use the `--allow_navigable_strings` parameter. This will add the strings to the translation queue. **Note that it's best to look for e-books that are more standardized if possible.** -### Eamples +### Examples ```shell # Test quickly