From 57be9d9e0c012eeb7026ab27df2d1d3462121edd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=8D=83=E4=BD=8F=E6=9F=B1=E9=96=93?= Date: Wed, 7 Feb 2024 17:32:04 +0000 Subject: [PATCH] Update README.md --- README.md | 73 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 39 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 501be32..4e61b46 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ It also provides links of available entries of smaller substrings. **Usage** ``` -gd-marisa --word %GDWORD% --sentence %GDSEARCH% --path-to-dic [PATH_TO_DIC_FILE] +gd-tools marisa --word %GDWORD% --sentence %GDSEARCH% ``` The path to the `.dic` is an optional argument and defaults to `/usr/share/gd-tools/marisa_words.dic` @@ -74,29 +74,24 @@ marisa-build < keyset.txt > keyset.dic More information at https://www.s-yata.jp/marisa-trie/docs/readme.en.html -## gd-mecab +## gd-ankisearch -This script passes a sentence through mecab in order to make every part of the sentence clickable. +This script searches Anki cards in your collection that contain %GDWORD%. -https://user-images.githubusercontent.com/50422430/226139459-0c8bcf0e-e68f-491e-8171-bae3f50a7ae1.mp4 +![screenshot](https://github.com/Ajatt-Tools/gd-tools/assets/69171671/45a6b3a1-97de-439c-8f17-bd6f81d81d73) -**Dependencies** +**Arguments:** -This script requires [MeCab](https://taku910.github.io/mecab/) and the IPA dictionary to be installed. -If you are on an Arch Linux system you can simply install the AUR package `mecab-ipa` to obtain both. +* `--field-name` `NAME` optional field to limit search to. +* `--deck-name` `NAME` optional deck to limit search to. +* `--show-fields` `VocabKanji,SentKanji` optional comma-separated list of fields to show. -**Command format** - -Add this script to GoldenDict under "Dictionaries" > "Programs" (format HTML), like this: +**Example invocation:** ``` -gd-mecab --word %GDWORD% --sentence %GDSEARCH% +gd-tools ankisearch --field-name VocabKanji --show-fields VocabKanji,SentKanji,Image,SentAudio --word %GDWORD% ``` -**Optional arguments** - -* `--font-size SIZE` the font size to be used, e.g. `30px`. -* `--user-dict FILE` full path to the user_dic.dic file. This is done automatically if you install via make. ## gd-images @@ -120,7 +115,7 @@ Font source: https://www.nihilist.org.uk/ **How to call**: ``` -gd-strokeorder --word %GDWORD% +gd-tools strokeorder --word %GDWORD% ``` ## gd-handwritten @@ -134,7 +129,7 @@ Font source: [ArmedLemon](https://github.com/Ajatt-Tools/gd-tools/blob/main/res/ **How to call**: ``` -gd-handwritten --word %GDWORD% +gd-tools handwritten --word %GDWORD% ``` ## gd-massif @@ -143,23 +138,6 @@ This script shows example sentences from https://massif.la/ ![image](https://user-images.githubusercontent.com/50422430/226018360-e46605f0-2fb4-481c-801e-73aca84fae70.png) -## gd-ankisearch - -This script searches Anki cards in your collection that contain %GDWORD%. - -![screenshot](https://github.com/Ajatt-Tools/gd-tools/assets/69171671/45a6b3a1-97de-439c-8f17-bd6f81d81d73) - -**Arguments:** - -* `--field-name` `NAME` optional field to limit search to. -* `--deck-name` `NAME` optional deck to limit search to. -* `--show-fields` `VocabKanji,SentKanji` optional comma-separated list of fields to show. - -**Example invocation:** - -``` -gd-ankisearch --field-name VocabKanji --show-fields VocabKanji,SentKanji,Image,SentAudio --word %GDWORD% -``` ## gd-mandarin @@ -171,3 +149,30 @@ It also automatically converts the sentence to traditional characters. To use `gd-mandarin`, you need to install `gd-tools` by running `./quickinstall.sh --mandarin`. + + + + +## gd-mecab + +This script passes a sentence through mecab in order to make every part of the sentence clickable. + +https://user-images.githubusercontent.com/50422430/226139459-0c8bcf0e-e68f-491e-8171-bae3f50a7ae1.mp4 + +**Dependencies** + +This script requires [MeCab](https://taku910.github.io/mecab/) and the IPA dictionary to be installed. +If you are on an Arch Linux system you can simply install the AUR package `mecab-ipa` to obtain both. + +**Command format** + +Add this script to GoldenDict under "Dictionaries" > "Programs" (format HTML), like this: + +``` +gd-tools mecab --word %GDWORD% --sentence %GDSEARCH% +``` + +**Optional arguments** + +* `--font-size SIZE` the font size to be used, e.g. `30px`. +* `--user-dict FILE` full path to the user_dic.dic file. This is done automatically if you install via make.