From 8f52ddc54b8c24f5ac164a413a38b6d9d6c6fe58 Mon Sep 17 00:00:00 2001 From: Artem Pianykh Date: Mon, 21 Oct 2019 10:12:15 -0700 Subject: [PATCH] [annotations] Add a README with a build instruction for maven Summary: Although, we have Makefile and BUCK build def, this is a maven project which is supposed to be released to Maven Central, so it's worth having a short instruction on how to build it with maven. Reviewed By: mityal Differential Revision: D18037109 fbshipit-source-id: 6aebf4384 --- infer/annotations/README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 infer/annotations/README.md diff --git a/infer/annotations/README.md b/infer/annotations/README.md new file mode 100644 index 000000000..297192c5a --- /dev/null +++ b/infer/annotations/README.md @@ -0,0 +1,14 @@ +# Infer annotations + +This project provides extra annotations for Java checkers, such as starvation or nullsafe. + +## How to build JARs (suitable for release) + +Make sure you have maven installed. `infer-annotaions` is a regular +maven project, so regular maven commands apply. The following commands might be of interest: + +1. Build artifact jar (the one with class files): `mvn package`. +2. Build sources jar: `mvn source:jar` +3. Clean: mvn clean + +The resulting artifacts will be under `target/` folder.