From d50a607c42cb4d2bac2ad2de4344e5e912815898 Mon Sep 17 00:00:00 2001 From: Stefan Vukovic Date: Thu, 23 May 2024 17:43:38 +0200 Subject: [PATCH] update readme and env example --- .env.example | 2 +- README.md | 2 -- instructions.md | 37 ------------------------------------- 3 files changed, 1 insertion(+), 40 deletions(-) delete mode 100755 instructions.md diff --git a/.env.example b/.env.example index 254ce62..67723d8 100755 --- a/.env.example +++ b/.env.example @@ -1,3 +1,3 @@ DEBUG_WORD=sehen -DICT_NAME=abc +DICT_NAME=abc #used as prefix, like abc-de-en.zip MAX_MEMORY_MB=8192 \ No newline at end of file diff --git a/README.md b/README.md index 396804b..60b346d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ -> ⚠️ The dictionary format requires Yomitan 24.01.20 to load, and 24.2.23 to work optimally. - Converts wiktionary data from https://kaikki.org/ to yomitan-compatible dictionaries. Converted dictionaries can be found in the [Releases](https://github.com/themoeway/kaikki-to-yomitan/releases) section. # Instructions diff --git a/instructions.md b/instructions.md deleted file mode 100755 index b32f724..0000000 --- a/instructions.md +++ /dev/null @@ -1,37 +0,0 @@ -(examples use German (de) to English (en)) - -## Basic Run - -1. Create a `.env` file based on `.env.example`. - -2. If your language is not in `languages.json`, add it. - -3. Run `./auto.sh German English`. - -4. Dictionaries should be in `data/language/de/en`. - -## Contributing - -The `auto.sh` can also be run with flags. - -- k: keep files (by default, the script deletes the downloaded files after running), -- d: redownload (by default, the script skips downloading if the file already exists), -- t: force_tidy (run tidy script again, even if its output already exists. useful when the tidy script is updated), -- y: force_ymt (run yomitan script again, even if its output already exists. useful when the yomitan script is updated), -- F: force = force_tidy + force_ymt, -- S: run for all source languages (`./auto.sh German English S` is like `./auto.sh * English`), -- T: run for all target languages (`./auto.sh German English T` is like `./auto.sh German *`). - -Most often, you will want to run `./auto.sh German English kty` to recreate the dictionaries, then load them in yomitan and test them. - -After a run, `data/language/de/en` should contain files with skipped tags for IPA and terms. Adding some to `tag_bank_ipa.json` or `tag_bank_term.json` is an easy way to improve the conversion for your language pair. - -### Tests - -Test inputs are in `data/test/kaikki`. Each line is a line from the corresponding kaikki file (from `data/kaikki`, after downloading). - -To fix something in the conversion of a word, add its line from `data/kaikki` to the corresponding test file in `data/test/kaikki`. -Then run `npm run test-write` to add it to the expected test output, and commit the changes (say `add baseline test for "word"`). -Now when you modify tidy-up or make-yomitan, you can run `npm run test-write` to see the changes you made. - -If you are making a change that shouldn't change the output, just run `npm run test` to check if anything broke. \ No newline at end of file