Skip to content

Commit 055ea77

Browse files
committed
update README and version
1 parent 1eb6ef2 commit 055ea77

File tree

2 files changed

+20
-8
lines changed

2 files changed

+20
-8
lines changed

README.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,39 @@
11
# Bouffier Java
2-
This convert Java source to AST representation.
2+
This is a tool for converting Java source to AST representation.
33

44
AST file support the follow formats.
55
- yaml
66
- xml
77

88
## Usage
9-
`BOUFFIER_JAVA_PROJECT_PATH`: This contains Java sources and output AST files (default is `/bouffier-java`)
9+
### `BOUFFIER_JAVA_PROJECT_PATH`
10+
The specified directory contains Java sources and output AST files (default is `/bouffier-java-project`)
11+
1012
This directory should have the following composition.
1113

1214
```bash
1315
projects/
1416
├── out
15-
│   └── {{AST file is output here}}
17+
│   └── {{AST files will be outputed here}}
1618
└── source
17-
└── {{There is Java sources}}
19+
└── {{Java sources}}
1820
```
1921

2022
So, you need to create a directory in this format and mount it.
2123

22-
`BOUFFIER_JAVA_FORMAT`: the format of output AST file. (default is `yaml`)
24+
### `BOUFFIER_JAVA_FORMAT`
25+
The format of output AST file. (default is `yaml`)
26+
27+
You can choose the following format.
28+
29+
- yaml
30+
- xml
31+
32+
### Quick Start
33+
Clone this repository and put java sources in `/tests/resources/source`.
34+
35+
Run by docker-compose.
2336

24-
### Example
2537
```bash
26-
$ docker run -e BOUFFIER_JAVA_FORMAT=xml -v {{your dir path}}:/bouffier-java taxio/bouffier-java
38+
$ docker-compose -f docker-compose.sample.yml up
2739
```

src/main/java/main/Main.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ public class Main {
2828

2929
static FormatType format;
3030
static Path projectPath;
31-
static final String version = "v0.0.1";
31+
static final String version = "v0.1.0";
3232

3333
public static void main(String[] args) {
3434
System.out.println("---------------------------------------------------\n");

0 commit comments

Comments
 (0)