# yGuard

**Repository Path**: anneng/yGuard

## Basic Information

- **Project Name**: yGuard
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2022-12-06
- **Last Updated**: 2022-12-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

yGuard
------

![Continous Integration for yGuard](https://github.com/yWorks/yGuard/workflows/Continous%20Integration%20for%20yGuard/badge.svg)

`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](https://www.yworks.com/), creator of the family of graph and diagram visualization frameworks [yFiles](https://www.yworks.com/yfiles) and other fine [products](https://www.yworks.com/products).

## Obtaining yGuard

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](https://www.yworks.com/downloads#yGuard).

## Usage

An online version of this documentation [is available](https://yworks.github.io/yGuard/).

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.

## Examples

`yGuard` comes with a exhaustive set of examples to cover many use cases. Please review the [list of examples in the examples directory](./examples).

## Users of `yGuard`

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

[<img src="docs/img/yFiles-text.svg" height="100"/>](https://www.yworks.com/products/yfiles)

[<img src="docs/img/dbvissplash.png" height="100"/>](https://www.dbvis.com/)

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

## Development

### Building

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](https://www.mkdocs.org/):

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

### Using IntellIJ with yGuard

`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.