mabogunje/yorudi

(Scala) Multi-Lingual Yoruba Dictionary # Yorùdí ## A Standardized, Accessible, & Downloadable Comprehensive Yoruba Multilingual Dictionary The Yorùdí project aims to compile a complete multi-lingual lexical database with Yoruba as the pivot language. The project is modelled after the CC-CEDICT project by Paul Andrew Denisowski which was itself modeled on the highly successful EDICT project by Jim Breen. The former being a Chinese-English Electronic Dictionary and the latter, a Japanese-English Dictionary. This dictionary, in addition to being standardized and downloadable by humans, also aims to be accessible to machines. As such, it consists of 3 parts: 1. A **Command Line interface** for programmers & programs to use directly. 2. A **REST API** for accessibility over the internet hosted on Azure 3. A **Simple Front-End** (modeled after Tangorin) hosted here on GitHub Pages The combination of these 3 access points provides a tool that gives access to the Yoruba language in a way that appeals to both programmers (like me), and the ordinary human user... at least I hope it does. ### Usage #### 1. Using the Command Line The Command Line application can be accessed by running the Yorudi Class as main i.e. `sbt runMain net.mabogunje.yorudi.Yorudi [required arguments] [optional arguments] [yoruba word]`. ##### 1.1 Required Arguments - **--dict** (dictionary) This specifies which dictionary you want to query. Acceptable values are: - **cms** This refers to the Church Missionary Society Yoruba Dictionary (currently incomplete) - **gpt** This refers to the ChatGPT dictionary (a dictionary of 100 of the most popular Yoruba words in each alphabet according to ChatGPT) - **names** This refers to the Yoruba Personal Names dictionary based on the book by *Adeboye Babalola & Olugboyega Alaba (currently incomplete) - **sample** This is a sample dictionary intended for testing ##### 1.2 Optional Arguments - **-s** (strict) Return only results with exact tone matches - **-g** (glossary) Return a glossary of …