9
0
mirror of https://github.com/LeavesMC/Leaves.git synced 2025-12-19 14:59:32 +00:00

[ci skip] Update doc

This commit is contained in:
violetc
2022-11-28 18:53:01 +08:00
parent cc8c2bbd44
commit c2369de2a5
4 changed files with 61 additions and 37 deletions

View File

@@ -19,28 +19,35 @@ In order to use Leaves as a dependency you must [build it yourself](https://gith
Each time you want to update your dependency you must re-build Leaves.
Leaves-API maven dependency:
```xml
<dependency>
<groupId>top.leavesmc.leaves</groupId>
<artifactId>leaves-api</artifactId>
<version>1.19.2-R0.1-SNAPSHOT</version>
<scope>provided</scope>
</dependency>
```kotlin
dependencies {
compileOnly("top.leavesmc.leaves:leaves-api:1.19.2-R0.1-SNAPSHOT")
}
```
Leaves-Server maven dependency:
```xml
<dependency>
<groupId>top.leavesmc.leaves</groupId>
<artifactId>leaves</artifactId>
<version>1.19.2-R0.1-SNAPSHOT</version>
<scope>provided</scope>
</dependency>
```
```kotlin
dependencies {
compileOnly("top.leavesmc.leaves:leaves:1.19.2-R0.1-SNAPSHOT")
}
```
## Building
Java17+
`./gradlew applyPatches`
You need JDK 17 and good internet connection
Clone this repo, run `./gradlew applyPatches`, then `./gradlew createReobfBundlerJar` form your terminal.
You can find jar in `build/libs` directory.
## Pull Request
See [Contributing](https://github.com/LeavesMC/Leaves/blob/master/docs/CONTRIBUTING.md)
## Special Thanks To:
[<img src="https://user-images.githubusercontent.com/21148213/121807008-8ffc6700-cc52-11eb-96a7-2f6f260f8fda.png" alt="" width="150">](https://www.jetbrains.com)
[JetBrains](https://www.jetbrains.com/), creators of the IntelliJ IDEA, supports We with one of their [Open Source Licenses](https://www.jetbrains.com/opensource/). We recommend using IntelliJ IDEA as your IDE.
`./gradlew createReobfBundlerJar`

View File

@@ -18,27 +18,35 @@ Leaves [![Leaves CI](https://github.com/LeavesMC/Leaves/actions/workflows/leaves
如果你要将Leaves作为依赖,那么你必须进行 [自行构建](https://github.com/LeavesMC/Leaves/blob/master/README_cn.md#自行构建)
Leaves-API:
```xml
<dependency>
<groupId>top.leavesmc.leaves</groupId>
<artifactId>leaves-api</artifactId>
<version>1.19.2-R0.1-SNAPSHOT</version>
<scope>provided</scope>
</dependency>
```kotlin
dependencies {
compileOnly("top.leavesmc.leaves:leaves-api:1.19.2-R0.1-SNAPSHOT")
}
```
Leaves-Server:
```xml
<dependency>
<groupId>top.leavesmc.leaves</groupId>
<artifactId>leaves</artifactId>
<version>1.19.2-R0.1-SNAPSHOT</version>
<scope>provided</scope>
</dependency>
```
```kotlin
dependencies {
compileOnly("top.leavesmc.leaves:leaves:1.19.2-R0.1-SNAPSHOT")
}
```
## 自行构建
需要Java17或更高版本
`./gradlew applyPatches`
你需要最低JDK17和一个可以正常访问各种git/maven库的网络
首先克隆此储存库,然后在你的终端里依次执行 `./gradlew applyPatches` 和 `./gradlew createReobfBundlerJar`
最后 你可以在 `build/libs` 文件夹里找到对应的jar文件
## 对于想要出一份力的开发者
可查看 [Contributing](https://github.com/LeavesMC/Leaves/blob/master/docs/CONTRIBUTING_cn.md)
## 特别感谢
[<img src="https://user-images.githubusercontent.com/21148213/121807008-8ffc6700-cc52-11eb-96a7-2f6f260f8fda.png" alt="" width="150">](https://www.jetbrains.com)
[JetBrains](https://www.jetbrains.com/)IntelliJ IDEA的创造者为Leaves提供了 [开源许可证](https://www.jetbrains.com/opensource/)。我们极力推荐使用IntelliJ IDEA作为你的IDE。
`./gradlew createReobfBundlerJar`

View File

@@ -2,3 +2,5 @@ Contributing to Leaves
===========
**English** | [中文](https://github.com/LeavesMC/Leaves/blob/master/docs/CONTRIBUTING.md)
TODO

View File

@@ -4,7 +4,7 @@ Contributing to Leaves
[English](https://github.com/LeavesMC/Leaves/blob/master/docs/CONTRIBUTING.md) | **中文**
我们很开心您愿意为我们的项目做出共享。一般来说我们对PR的审核是十分宽松的
我们很开心您为我们的项目做出共享。一般来说我们对PR的审核是十分宽松的
但是如果您可以遵守下列的规则,我们可以更快地完成审核。
## 使用个人账户进行fork
@@ -62,4 +62,11 @@ Leaves使用和Paper一样的补丁系统并为了针对不同部分的修改
## 修改补丁
你可以使用以下方法来修改一个补丁的内容
1. 在HEAD上直接进行修改
2. 使用`git commit -a --fixup <hash>`来进行一个更正提交
- 如果你想要更改提交信息,你也可以用`--squash`来代替`--fixup`
3. 使用`git rebase -i --autosquash base`来进行自动变基 你只需要输入`:q`来关闭确认页面即可
4. 运行gradle任务`rebuildPatches`来修改已被修改的补丁
5. 将修改后的补丁PR会次出储存库