From dc29420c46f3c8a400cb427d45d7c3f8fa2f7d44 Mon Sep 17 00:00:00 2001 From: PeratX <1215714524@qq.com> Date: Fri, 21 Feb 2020 11:55:14 +0800 Subject: [PATCH] README: update eng --- README-eng.md | 39 ++++++++++++++++++++++++++++++--------- README.md | 1 + 2 files changed, 31 insertions(+), 9 deletions(-) diff --git a/README-eng.md b/README-eng.md index 236fa9166..7f2751305 100644 --- a/README-eng.md +++ b/README-eng.md @@ -6,14 +6,16 @@ Some of the protocol came from the other open-source projects. **The development is only for learning, DO NOT use it for illegal purposes.** -## UpdateLog +## Changelog + You can inspect supported protocols at [Project](https://github.com/mamoe/mirai/projects/1) -and logs of updates at [UpdateLog](https://github.com/mamoe/mirai/blob/master/UpdateLog.md) +and logs of updates at [CHANGELOG](https://github.com/mamoe/mirai/blob/master/CHANGELOG.md) ## Use as a library You can install mirai as a library into your project. -Mirai is only published on `jcenter`, therefore please ensure you have the `jcenter()` repository in your `build.gradle`, like: +Mirai is only published on `jcenter`, therefore please ensure you have the `jcenter()` repository in your `build.gradle`. + ```kotlin repositories{ jcenter() @@ -23,7 +25,8 @@ repositories{ If your project is a multiplatform project, you should add dependencies for each platform respectively. If your project is not a multiplatform project, you just need to add the platform-specific dependency. -`VERSION` should be replaced with the newest version, say [![Download](https://api.bintray.com/packages/him188moe/mirai/mirai-core/images/download.svg)](https://bintray.com/him188moe/mirai/mirai-core/) +`VERSION` should be replaced with the newest version, say [![Download](https://api.bintray.com/packages/him188moe/mirai/mirai-core/images/download.svg)](https://bintray.com/him188moe/mirai/mirai-core/) + Mirai is still under experimental stage, it is suggested to keep the version newest. **common** @@ -71,14 +74,20 @@ If you meet any problem or have any questions, be free to open a issue. Our goal Kotlin 1.3.61 On JVM: Java 6 + On Android: SDK 15 ### Using java Q: Can I use Mirai without Kotlin? + A: Calling from java is not yet supported. Coroutines, extensions and inlines, which are difficult to use from Java, are generally used in Mirai. Therefore you should have the skill of Kotlin before you use Mirai. -#### Libraries used -Mirai uses these open-source libraries. +## Acknowledgements + +Thanks to [JetBrains](https://www.jetbrains.com/?from=mirai) for allocating free open-source licences for IDEs such as [IntelliJ IDEA](https://www.jetbrains.com/idea/?from=mirai). +[](https://www.jetbrains.com/?from=mirai) + +### Third Party Libraries - [kotlin-stdlib](https://github.com/JetBrains/kotlin) - [kotlinx-coroutines](https://github.com/Kotlin/kotlinx.coroutines) @@ -92,7 +101,19 @@ Mirai uses these open-source libraries. - [javafx](https://github.com/openjdk/jfx) - [kotlinx-serialization](https://github.com/Kotlin/kotlinx.serialization) +## License -## Acknowledgement -Thanks to [JetBrains](https://www.jetbrains.com/?from=mirai) for allocating free open-source licences for IDEs such as [IntelliJ IDEA](https://www.jetbrains.com/idea/?from=mirai). -[](https://www.jetbrains.com/?from=mirai) \ No newline at end of file + Copyright (C) 2019-2020 mamoe and Mirai contributors + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . diff --git a/README.md b/README.md index 65c615de7..6d69c5e0d 100644 --- a/README.md +++ b/README.md @@ -134,6 +134,7 @@ TIM PC （2.3.2 版本，2019 年 8 月）协议的实现 - (见 LICENSE 第 13 节) 尽管本许可协议有其他规定，但如果您修改本程序，则修改后的版本必须显着地为所有通过计算机网络与它进行远程交互的用户（如果您的版本支持这种交互）提供从网络服务器通过一些标准或惯用的软件复制方法**免费**访问相应的**源代码**的机会 - (见 LICENSE 第 4 节) 您可以免费或收费地传递这个项目的源代码或目标代码(即编译结果), **但前提是提供明显的版权声明** (您需要标注本 `GitHub` 项目地址) +------ Copyright (C) 2019-2020 mamoe and Mirai contributors