Skip to content

Commit

Permalink
docs: more clarity on how developers can use.
Browse files Browse the repository at this point in the history
  • Loading branch information
QwQ-dev committed Dec 27, 2024
1 parent 13093f4 commit a2e5027
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 31 deletions.
29 changes: 4 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,37 +16,17 @@ The overall dependence is on the [Fairy Framework](https://github.com/FairyProje

## usage

Please download all `artifacts` in [Actions](https://github.com/LegacyLands/legacy-lands-library/actions) and install them as plugins.
In the compressed package downloaded by [Actions](https://github.com/LegacyLands/legacy-lands-library/actions), `-javadoc` is the javadoc build, `-plugin` only has the compiled class files, and `-sources` has not only the compiled class files but also the source code.

The usage of a particular module is described in detail in the module's `README.md`.

It should be noted that the entire library fully depends on [Fairy Framework](https://github.com/FairyProject/fairy), which will completely simplify our development process and provide various functions. It also depends on [fairy-lib-plugin](https://github.com/FairyProject/fairy-lib-plugin).

### for developer
We recommend that developers import `-sources` to view javadoc more conveniently in IDA.

You can use jar files ending with sources as dependencies, which include both compiled binary files and source code.
To run the module as a plugin (which is the recommended way), run the `-plugin` file directly as a plugin.

The GitHub Packages repository will open soon.

<!--Please configure your GitHub Username and GitHub Token
* Maven Repo:
```kts
repositories {
maven {
url = uri("https://maven.pkg.github.com/LegacyLands/legacy-lands-library")
}
}
```
* Artifact Information:
```kts
dependencies {
implementation("net.legacy.library:{module}:{version}")
}
```
You can get all modules and versions here [GitHub Packages](https://github.com/LegacyLands/legacy-lands-library/packages)-->
**_You need to be careful about dependencies between modules!_**

## modules

Expand All @@ -63,7 +43,6 @@ The project is fully sponsored and maintained by [LegacyLands](https://github.co

![legacy-lands-logo.png](./legacy-lands-logo.png)


## star history

We are honored that this library can help more people!
Expand Down
2 changes: 1 addition & 1 deletion annotation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ automated annotation processor. This is very useful for repeatedly performing ce
// Dependencies
dependencies {
// annotation module
compileOnly("net.legacy.library:annotation:1.0-SNAPSHOT")
compileOnly(files("libs/annotation-1.0-SNAPSHOT.jar"))
}
```

Expand Down
2 changes: 1 addition & 1 deletion cache/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The multi-level cache originally expected to be handled by the `data` module wil
// Dependencies
dependencies {
// cache module
compileOnly("net.legacy.library:cache:1.0-SNAPSHOT")
compileOnly(files("libs/cache-1.0-SNAPSHOT.jar"))
}
```

Expand Down
2 changes: 1 addition & 1 deletion commons/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ this document when there's new content.
// Dependencies
dependencies {
// commons module
compileOnly("net.legacy.library:commons:1.0-SNAPSHOT")
compileOnly(files("libs/commons-1.0-SNAPSHOT.jar"))
}
```

Expand Down
4 changes: 2 additions & 2 deletions configuration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ safely in a multi-threaded environment.
// Dependencies
dependencies {
// annotation module
compileOnly("net.legacy.library:annotation:1.0-SNAPSHOT")
compileOnly(files("libs/annotation-1.0-SNAPSHOT.jar"))

// configuration module
compileOnly("net.legacy.library:configuration:1.0-SNAPSHOT")
compileOnly(files("libs/configuration-1.0-SNAPSHOT.jar"))
}
```

Expand Down
2 changes: 1 addition & 1 deletion mongodb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ For the first and second level cache, it is actually implemented in the cache mo
// Dependencies
dependencies {
// mongodb module
compileOnly("net.legacy.library:mongodb:1.0-SNAPSHOT")
compileOnly(files("libs/mongodb-1.0-SNAPSHOT.jar"))
}
```

Expand Down

0 comments on commit a2e5027

Please sign in to comment.