Naum is a tool that checks Java libraries for binary compatibility with previous releases
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
config
gradle
subprojects
.gitignore
.travis.yml
CONTRIBUTING.md
LICENSE
README.adoc
build.gradle
gradle.properties
gradlew
gradlew.bat
settings.gradle
tmp.xml
todo.txt

README.adoc

Naum

Build Status (travis) Coverage Status (coveralls) ASL2 Licensed download


Naum is a tool that checks Java libraries for binary compatibility with previous releases.

Installing

You can get the latest version of naum directly from Bintray’s JCenter repository.

Refer to the guide for further information on configuration and usage.

Building

You must meet the following requirements:

  • JDK8u40 as a minimum

  • Gradle 3.1

You may used the included gradle wrapper script if you don’t have gradle installed.

Installing Gradle

Manual
  1. Download Gradle from http://gradle.org/downloads

  2. Unzip the file into a directory without spaces (recommended).

  3. Create a GRADLE_HOME environment variable that points to this directory.

  4. Adjust your PATH environment variable to include $GRADLE_HOME/bin (%GRADLE_HOME%\bin on Windows).

  5. Test your setup by invoking gradle --version.

SDKMAN
  1. Follow the instructions found at http://sdkman.io/ to install SDKMAN.

  2. You need a POSIX environment if running Windows. We recommend using Babun Shell (http://babun.github.io/)

  3. Once SDKMAN is installed invoke sdk install gradle 3.1.

  4. Test your setup by invoking gradle --version.

Gdub

GDub is a wrapper script that facilitates invoking gradle tasks anywhere within a Gradle project. It’s smart enough to use the gradle wrapper if available or your global gradle command. This is an optional download.

  1. Follow the instructions found at https://github.com/dougborg/gdub to install gdub

Next Steps

Make a full build issuing gradle build.

IDE integration

IntelliJ IDEA
  1. To create an IntelliJ Idea project, run ./gradlew clean idea

  2. Make sure to install the Lombok plugin

  3. Check that annotation processing is enabled (should be if you created the plugin with the above command).