gaecom / yguard Goto Github PK

yGuard is an open-source Java obfuscation tool. With yGuard it is easy as pie (🍰) to configure obfuscation through an extensive ant task.

yGuard is brought to you by yWorks GmbH, creator of the family of graph and diagram visualization frameworks yFiles and other fine products.

Recent yGuard releases can be downloaded from GitHub, or used from Maven central directly.

Previous releases may still be downloaded from the yWorks download center.

An online version of this documentation is available.

Additionally, yGuard is distributed with usage instructions. In your distribution, the docs folder contains informtion about yGuard. Browse docs/index.html to view the documentation.

yGuard comes with a exhaustive set of examples to cover many use cases. Please review the list of examples in the examples directory.

Below you will find a list of users relying on yGuard to keep their product secure.

If your product uses yGuard as well and you would like to add it to this list, please contact us.

To build yGuard you will need Java >= 7.

Download the repository and build yGuard using ./gradlew build.

The bundle version (for Ant users) is built using the assembleBundleDist task (e.g ./gradlew assembleBundleDist). The assembleBundleDist task comes with a optional parameter to copy documentation (-Pcopy-docs).

In order to build the documentation you will need mkdocs:

pip3 install mkdocs mkdocs-material # or use a virtual environment if you prefer
mkdocs build

yGuard will be loaded without further ado from IntellIJ thanks to the Gradle integration. Opening the yGuard folder will set up Gradle and mark sources, tests and resources accordingly.