Skip to content

Commit

Permalink
idiot-proof installation and usage
Browse files Browse the repository at this point in the history
  • Loading branch information
Eisenwave committed Feb 3, 2021
1 parent 43f4e40 commit c79affe
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,16 @@ cd build
cmake ..
make # optionally with -j <number of threads> option for multithreaded compile
```
After installing, the executable will be in your `build` directory.

## Usage

```sh
# Usage (the -t and -s options is optional)
obj2voxel input_file output_file -t <texture_file> -r <resolution:uint> -s <color_strategy:(max|blend)>
./obj2voxel input_file output_file -t <texture_file> -r <resolution:uint> -s <color_strategy:(max|blend)>

# Example
obj2voxel in.obj out.qef -t texture.png -r 128 -s max
./obj2voxel in.obj out.qef -t texture.png -r 128 -s max
```

**Explanation:** obj2voxel takes only positonal arguments:
Expand Down

0 comments on commit c79affe

Please sign in to comment.