Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Vuizur committed Dec 15, 2021
1 parent e2b5713 commit 54f1abe
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
# Ebook dictionary creator

This project has two goals:
1. The first is to create a performant database containing words and their definitions, including all inflections and proper linkages between them. This allows you to get the definition of a word regardless of the word's form. I will soon add an example explaining how you can use this as a fast dictionary with only one SQL query.
2. Based on this data, it creates high-quality dictionaries compatible with recent ebook readers. It uses an algorithm to fix bugs in the Kindle lookup engine. Look in the releases section for already available dictionaries.
1. The first is to create a performant database containing words and their definitions, including all inflections and proper linkages between them. This allows you to get the definition of a word regardless of the word's case/tense. I will soon add an example explaining how you can use this as a fast dictionary with only one SQL query.
2. Based on this data, it creates high-quality dictionaries compatible with recent ebook readers. It uses an algorithm to fix bugs in the Kindle lookup engine for this that prevent inflections from being found - even official dictionaries suffer from it. Look in the releases section for already available dictionaries.
3. I will soon release the dictionaries as a Tabfile so that you can convert it to other formats as well

Contributions and feedback about words that are not displayed correctly or unhelpful definitions (I tried to remove them all/link them to parent definitions) are always welcome. Additionally, you can tell me if the dictionary for your language is missing essential information.

### Acknowledgements
This project would not have been possible without the https://kaikki.org/ data provided by Tatu Ylonen, the OpenRussian data and the Pyglossary library for the creation of the Kindle dictionary

Expand All @@ -16,5 +15,4 @@ https://github.com/nyg/wiktionary-to-kindle

https://github.com/efskap/kindlewick apparently works very similarly, also supports inflections, as of now it only supports smaller languages though (has been tested for Finnish).


https://github.com/BoboTiG/ebook-reader-dict is a program that parses the Wiktionary dump itself and outputs Kobo compatible files

0 comments on commit 54f1abe

Please sign in to comment.