Skip to content

Commit f26af81

Browse files
committed
updated README
1 parent 8163cb2 commit f26af81

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,12 @@ HoneyAnt is an incremental [Ant](http://ant.apache.org/) build plugin for [Eclip
88
When you save a Java file, HoneyAnt runs its build script automatically.
99

1010
This plugin provides similar functions to APT (Annotation Processing Tool), but HoneyAnt is more powerful and freely !
11-
You can run **any** Ant build script when you change the Java file. File generation, testing, etc, etc ...
11+
You can run **any** Ant build script when you change the annotated Java file. File generation, testing, etc, etc ...
1212

1313
If it is an incremental build (after file editing) and cache enabled, HoneyAnt runs its build script only when the source file is changed.
1414
However, if it is full build (project cleaning), HoneyAnt always runs its build script.
1515

16+
1617
## Install
1718

1819
Currently HoneyAnt does not provide an update-site. Please install plugin from cloned git repository.
@@ -22,6 +23,25 @@ Currently HoneyAnt does not provide an update-site. Please install plugin from c
2223
3. Restart Eclipse.
2324
3. Select your Java Project and configure HoneyAnt page.
2425

26+
27+
## Configuration
28+
29+
* Build file : the Ant build file.
30+
* Build target : the Ant build target.
31+
* Build trigger annotation : the HoneyAnt build trigger annotation (simple name).
32+
* Cache directory : the directory which HoneyAnt puts its build result caches (file digest).
33+
* Enable cache : set true if you want to avoid unnecessary build.
34+
* Enable incremental build : set true if you want to build incrementally.
35+
36+
37+
## Ant Task Environments
38+
39+
HoneyAnt runs its build script with following properties.
40+
41+
* clazz : The full qualified class name of triggered Java file.
42+
* path : The absolute file path of triggered Java file.
43+
44+
2545
## Example
2646

2747
See [Example](https://github.com/monzou/honeyant/tree/master/honeyant-example).

0 commit comments

Comments
 (0)