Use Eclipse JDT null annotations
[null-analysis.git] / README.textile
blob848caaec9cbfcefa9df46f43a194d5d383e35a2d
1 h1. Null-Analysis "!https://secure.travis-ci.org/sebhoss/null-analysis.png!":http://travis-ci.org/sebhoss/null-analysis "!https://www.ohloh.net/p/null-analysis/widgets/project_thin_badge.gif!":https://www.ohloh.net/p/null-analysis/
3 p. Helpers for null analysis in Java projects.
6 h2. Usage
8 p. Simply reference this module as a dependency to your POM:
10 bc. 
11 <dependency>
12   <groupId>com.github.sebhoss</groupId>
13   <artifactId>null-analysis</artifactId>
14   <version>[1.0.0,2.0.0)</version>
15 </dependency>
18 h2. Development
20 h3. License
22 p. This program is free software. It comes without any warranty, to the extent permitted by applicable law. You can redistribute it and/or modify it under the terms of the Do What The Fuck You Want To Public License, Version 2, as published by Sam Hocevar. See LICENSE or "http://www.wtfpl.net/":http://www.wtfpl.net/ for more details.
24 h3. Setup
26 p. This projects uses "Java":http://www.java.com/, "Maven":http://maven.apache.org/ and "Git":http://git-scm.com/ as the main development tools. To build the project yourself just download & install at least Maven 3.0 and call *mvn install* inside the project folder. Maven should then proceed to clean, build, package and install this project.
28 h3. Versioning
30 p. This project follows the "semantic versioning":http://semver.org/ guidelines.