Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jjfumero authored Feb 21, 2022
1 parent 3edaac8 commit 54aa960
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ $ mvn clean install
```

#### Structure of this Repository
There are 3 modules: `generator`, `lib`, `runner`.

There are 3 Java modules: `generator`, `lib`, `runner`.

The `generator` module is a standalone program that reads the included SPIR-V grammar files and writes classes needed by `lib` to the specified output directory.

Expand Down Expand Up @@ -59,8 +60,11 @@ The `runner` module is the "front-end" for the `lib` module. It only handles CLI

Maven will create a fat-jar, that includes both `lib` and `runner` in the dist directory.


## Usage

The running is a client application to be used from the the command line that allows developers to assembly SPIRV written in a text format into a SPIRV binary module, and dissasemble SPIRV modules into a text format. The application can be used as follows:

```bash
spirv-beehive-toolkit [OPTIONS] <filepath>
-c,--no-color Do not use coloured output
Expand Down

0 comments on commit 54aa960

Please sign in to comment.