Skip to content

Commit

Permalink
Updated readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
clnhlzmn committed Mar 23, 2021
1 parent ac295ba commit 6322755
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,9 +120,19 @@ Clone the repo and build the makina-compiler project using Intellij. Or download
### Run the compiler

```
java -jar <path>/<to>/makina-compiler.jar <input-file> [<input-file-2>]
java -jar <path>/<to>/makina-compiler.jar <input-file> [<input-file-2>] [<other-options>]
```

### Output

Two files, `<machine-name>.h` and `<machine-name>.c` will be created (or overwritten!) in the same directory as `<input-file>`.
Two files, `<machine-name>.h` and `<machine-name>.c` will be created (or overwritten!) in the same directory as `<input-file>` or in the specified output directory.

### Command line options

`-o <path>` or `--output <path>`: Specify the output path for generated files.

`-m <type>` or `--machine-data <type>`: Specify the type of the `ctx` member of the generated machine type. The default type is `void *`. May occur zero or one times.

`-e <type>` or `--event-data <type>`: Specify the type of the `ctx` member of the generated event type. The default type is `void *`. May occur zero or one times.

`-i <file>` or `--include <file>`: Specify files to include in the generated C header. This can be used to provide definitions of custom types specified with `-e` or `-m`. May occur zero or more times.

0 comments on commit 6322755

Please sign in to comment.