chinese-transliteration/README.md

45 lines
1.0 KiB
Markdown
Raw Normal View History

2024-09-20 10:35:42 +00:00
# Pinyin Mapper for Kotlin
A Pinyin Mapper written in [Kotlin](https://kotlinlang.org).
## Installation
_Pinyin Mapper for Kotlin_ is available
from [my self-hosted Gitea instance](https://gitea.marvinelsen.com/marvinelsen/cedict-parser).
First, add the repository to your `build.gradle.kts` file:
```kotlin
repositories {
maven {
url = uri("https://gitea.marvinelsen.com/api/packages/marvinelsen/maven")
}
}
```
Afterwards, add the package dependency to your `build.gradle.kts` file:
```kotlin
dependencies {
implementation("com.marvinelsen:pinyin-mapper:1.0-SNAPSHOT")
}
```
## Usage
```kotlin
fun main() {
TODO()
}
```
## License
All source code in this repository is licensed under a [MIT license](LICENSE), unless otherwise noted.
To the following third-party code, data, and files in the repository different licenses apply:
### 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/).