Skip to content

Commit f68453f

Browse files
committed
Additional info in the readme on how to use the tool without JSON files.
1 parent be77725 commit f68453f

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,20 @@ git submodule update
3939

4040
## CLI interface
4141

42+
This program has two ways of being used:
43+
- through Blender-style JSON configuration files.
44+
- by manually specifying the lens characteristics on the command line.
45+
46+
Originally, this tool was made to convert images generated by Blender, from one
47+
lens type to another. However, as this tool had potential to be used in other
48+
contexts, where no configuration files from Blender were available, simpliy
49+
specifying which lens-type the input image has directly on the command-line
50+
was very desirable. To specify the input image lens-type directly on the
51+
command-line, use the `--no-configs` argument along with `--i-...` flags under
52+
the `Input optics` section. When using `equirectangular` panoraminc input
53+
images, the `--rotation` flag might prove useful.
54+
55+
4256
```
4357
Usage:
4458
./bin/reproject [OPTION...]

0 commit comments

Comments
 (0)