Skip to content

Commit

Permalink
update README and version
Browse files Browse the repository at this point in the history
  • Loading branch information
taxio committed Aug 5, 2019
1 parent 1eb6ef2 commit 055ea77
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 8 deletions.
26 changes: 19 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,39 @@
# Bouffier Java
This convert Java source to AST representation.
This is a tool for converting Java source to AST representation.

AST file support the follow formats.
- yaml
- xml

## Usage
`BOUFFIER_JAVA_PROJECT_PATH`: This contains Java sources and output AST files (default is `/bouffier-java`)
### `BOUFFIER_JAVA_PROJECT_PATH`
The specified directory contains Java sources and output AST files (default is `/bouffier-java-project`)

This directory should have the following composition.

```bash
projects/
├── out
│   └── {{AST file is output here}}
│   └── {{AST files will be outputed here}}
└── source
└── {{There is Java sources}}
└── {{Java sources}}
```

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

`BOUFFIER_JAVA_FORMAT`: the format of output AST file. (default is `yaml`)
### `BOUFFIER_JAVA_FORMAT`
The format of output AST file. (default is `yaml`)

You can choose the following format.

- yaml
- xml

### Quick Start
Clone this repository and put java sources in `/tests/resources/source`.

Run by docker-compose.

### Example
```bash
$ docker run -e BOUFFIER_JAVA_FORMAT=xml -v {{your dir path}}:/bouffier-java taxio/bouffier-java
$ docker-compose -f docker-compose.sample.yml up
```
2 changes: 1 addition & 1 deletion src/main/java/main/Main.java
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public class Main {

static FormatType format;
static Path projectPath;
static final String version = "v0.0.1";
static final String version = "v0.1.0";

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

0 comments on commit 055ea77

Please sign in to comment.