From ae6392aafd425654d73d281dd3ad1b413956ce95 Mon Sep 17 00:00:00 2001 From: Cedric Beust Date: Fri, 13 Nov 2015 17:45:56 -0800 Subject: [PATCH] README. --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 15b6b6d..363f02c 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,15 @@ There are two modules in this project: - The processor (`processor/`) - The example using the processor (`example/`) -The `processor` project defines an annotation `Version` that lets you specify a version number. When the annotation processor is run, it generates a source file `GeneratedVersion.java` with a static field contains that version number. +The `processor` project defines an annotation `@Version` that lets you specify a version number. When the annotation processor is run, it generates a source file `GeneratedVersion.java` with a static field containing that version number. The `example` project has a single class `Example` which is annotated with `@Version` and which then displays the value of the version from the `GeneratedVersion` generated class. -Build with `./kobaltw run`. +To build and run the example: + +``` + +./kobaltw run + +``` +