diff options
Diffstat (limited to 'readme.md')
| -rw-r--r-- | readme.md | 34 |
1 files changed, 9 insertions, 25 deletions
@@ -15,23 +15,6 @@ API~, and aims to provide extra features that help with immersion and sentence mining on top of the base word lookup that Yomichan provided. **While Yomikun's scope is larger than Yomichan, it's still focused on Japanese only.** -## TODO - -- [x] working proof of concept sentence lookup using deno/sqlite3 -- [ ] port dictionaries for more advanced testing - - [x] JMdict (WIP) - - [ ] JMNedict -- [ ] add separate kanji readings/info table -- [ ] add separate frequency dictionary -- [x] add more deinflections to db/deinflections.sql -- [x] set up unit tests for sentence reading generation -- [x] port server-internal API to simple HTTP JSON API -- [ ] create primitive search page ui -- [ ] add code formatter config -- [ ] complete documentation -- [ ] remove makefiles for database initialization -- [ ] replace .sql script files with typescript sql query generation library - ## ~New features (from Yomichan)~ NONE OF THESE ARE IMPLEMENTED YET @@ -52,14 +35,15 @@ NONE OF THESE ARE IMPLEMENTED YET ## Documentation -Some general documentation is done in markdown, but other general documentation -should be done in JSDoc format in the corresponding code files. The -documentation also makes frequent references to, and uses terminology from [Tae -Kim's Japanese grammar guide][taekim], which is abbreviated to [taekim] instead -of copying the link into the source code each time. Tae Kim uses slightly -different terms for grammatical concepts. The 'Tae Kim-version' of these terms -is used for named constants in code. See [tags.ts](language/tags.ts) for an -overview of relevant grammatical terms for the Yomikun parser. +Some general project structure documentation is done in markdown, but other +specific documentation (on algorithms, data structures, etc.) should be done in +JSDoc format in the corresponding code files. The documentation also makes +frequent references to, and uses terminology from [Tae Kim's Japanese grammar +guide][taekim], which is abbreviated to [taekim] instead of copying the link +into the source code each time. Tae Kim uses slightly different terms for +grammatical concepts. The 'Tae Kim-version' of these terms is used for named +constants in code. See [tags.ts](search/tags.ts) for an overview of relevant +grammatical terms for the Yomikun parser. ## The dream |