Add a note about which libraries get shaded where

This commit is contained in:
Kenzie Togami 2019-04-20 23:36:44 -07:00
parent 5c19866809
commit 73d5681926
No known key found for this signature in database
GPG Key ID: 5D200B325E157A81

View File

@ -1,5 +1,17 @@
import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
/*
This project shades <em>API</em> libraries, i.e. those libraries
whose classes are publicly referenced from `-core` classes.
This project <em>does not</em> shade implementation libraries, i.e.
those libraries whose classes are internally depended on.
This is because the main reason for shading those libraries is for
their internal usage in each platform, not because we need them available to
dependents of `-core` to compile and work with WorldEdit's API.
*/
subprojects {
apply plugin: 'maven'
apply plugin: 'com.github.johnrengelman.shadow'