Skip to content

Commit

Permalink
Slight tweaks to recent PR doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
Jonne Nauha authored Jul 29, 2017
1 parent 0144ea7 commit 9bc909f
Showing 1 changed file with 18 additions and 15 deletions.
33 changes: 18 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,21 +17,6 @@ This tool can be destructive and contain bugs, it will not let you overwrite the

If a particular line in the input file is not supported by the parser, the tool will exit and print a link to submit an issue. If you are submitting an issue please attach a file that can reproduce the bug.

## Quickstart

After [installing go](https://golang.org/doc/install) (verify with `go version`, and don't forget the PATH steps), install and run this tool:

```bash
# Install
go get github.com/jonnenauha/obj-simplify

# Run
obj-simplify -in <input-file> -out <output-file>

# Help
obj-simplify -h
```

## Merging duplicate geometry

Use `-eplison` to tune vector equality checks, the default is `1e-6`. This can have a positive impact especially on large OBJ files. Basic cleanup like trimming trailing zeros and converting -0 into 0 to reduce file size is also executed.
Expand Down Expand Up @@ -59,6 +44,24 @@ I have contributed to the OBJ parser/loader in three.js and know it very well. I
* Remove patterns that result in using `THREE.MultiMaterial`.
* Reduce draw calls.

## Dev quickstart

* [Install go](https://golang.org/doc/install)
* Verify with `go version` that the tools are in your PATH

```bash
# Install
go get github.com/jonnenauha/obj-simplify

# Run
cd $GOPATH/src/github.com/jonnenauha/obj-simplify # or just run where you are if you have $GOPATH/bin in your PATH
obj-simplify -in <input-file> -out <output-file>
obj-simplify -h # for full help

# Modify source code and
go build
```

## Command line options

There are command line flags for configuration and disabling processing steps, see `-h` for help.
Expand Down

0 comments on commit 9bc909f

Please sign in to comment.