Add Documentation #2

Merged
marvinelsen merged 3 commits from add_documentation into main 2024-09-15 14:03:01 +00:00
Showing only changes of commit 2e9d14944b - Show all commits

View File

@ -1,6 +1,7 @@
# CC-CEDICT Parser for Kotlin
A parser for the [CC-CEDICT](https://www.mdbg.net/chinese/dictionary?page=cedict) written in [Kotlin](https://kotlinlang.org).
A parser for the [CC-CEDICT](https://www.mdbg.net/chinese/dictionary?page=cedict) Chinese-to-English dictionary written
in [Kotlin](https://kotlinlang.org).
## Installation
@ -29,7 +30,8 @@ dependencies {
```kotlin
fun main() {
val cedictInputStream = GZIPInputStream(object {}.javaClass.getResourceAsStream("/cedict_1_0_ts_utf-8_mdbg.txt.gz")!!)
val cedictInputStream =
GZIPInputStream(object {}.javaClass.getResourceAsStream("/cedict_1_0_ts_utf-8_mdbg.txt.gz")!!)
val cedictParser = CedictParser.instance
val cedictEntries = cedictParser.parseCedict(cedictInputStream)
@ -51,4 +53,5 @@ To the following third-party code, data, and files in the repository different l
### CC-CEDICT
[CC-CEDICT](https://cc-cedict.org/wiki) is licensed under a [Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/).
[CC-CEDICT](https://cc-cedict.org/wiki) is licensed under
a [Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/).