Skip to content

Commit

Permalink
Update readme: make latest release link more obvious, add note that l…
Browse files Browse the repository at this point in the history
…ocal Gradle installation is not necessary
  • Loading branch information
scriptin committed Jun 2, 2019
1 parent 6e78ae4 commit 07b869c
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

> [JMdict](http://www.edrdg.org/jmdict/j_jmdict.html) and [JMnedict](http://www.edrdg.org/enamdict/enamdict_doc.html) in JSON format with more comprehensible structure.
**[LATEST RELEASE](https://github.com/scriptin/jmdict-simplified/releases/latest)**

## Why?

Original XML files are... less than ideal. This project provides the following improvements:
Expand All @@ -11,14 +13,14 @@ Original XML files are... less than ideal. This project provides the following i
3. [Array fields are never `null` or missing, always empty arrays](http://thecodelesscode.com/case/6)
4. JSON is better than XML :trollface:

Grab results here: **[Latest release](https://github.com/scriptin/jmdict-simplified/releases/latest)**

Note: There are two versions of the JMdict dictionary: full and "common"-only. Dictionary entries are considered common if `/k_ele/ke_pri` or `/r_ele/re_pri` elements in original file contain one of these markers: "news1", "ichi1", "spec1", "spec2", "gai1". Common-only distributions are much smaller. JMnedict has only one version.

## Requirements

- Java 8+

NB: Java is the only requirement, you don't need to have Gradle installed, just use Gradle wrapper provided in this repository: `./gradlew` or `gradlew.bat`

## Building

Use included scripts: `gradlew` for Linux/Mac OS, `gradlew.bat` for Windows.
Expand Down

0 comments on commit 07b869c

Please sign in to comment.