Skip to content

Commit

Permalink
Additional info in the readme on how to use the tool without JSON files.
Browse files Browse the repository at this point in the history
  • Loading branch information
mcourteaux committed Nov 14, 2023
1 parent be77725 commit f68453f
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,20 @@ git submodule update

## CLI interface

This program has two ways of being used:
- through Blender-style JSON configuration files.
- by manually specifying the lens characteristics on the command line.

Originally, this tool was made to convert images generated by Blender, from one
lens type to another. However, as this tool had potential to be used in other
contexts, where no configuration files from Blender were available, simpliy
specifying which lens-type the input image has directly on the command-line
was very desirable. To specify the input image lens-type directly on the
command-line, use the `--no-configs` argument along with `--i-...` flags under
the `Input optics` section. When using `equirectangular` panoraminc input
images, the `--rotation` flag might prove useful.


```
Usage:
./bin/reproject [OPTION...]
Expand Down

0 comments on commit f68453f

Please sign in to comment.