Skip to content

Commit 1ab31b4

Browse files
committed
documentation
1 parent cd39bbf commit 1ab31b4

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,24 @@ I've only tested it, and the executable, on Windows 10.
1010

1111
![tl;dr console image](docs/assets/tldr-console.png)
1212

13+
Configuration values can be specified in configuration files or, in some
14+
cases, from the command line. Anything that's required and missing from
15+
the configuration files will be prompted for at the console (you can also
16+
force the app to confirm configuration values through the console).
17+
1318
You will need a Bing or Google API key for the library and program to
1419
work.
1520

1621
### Command line options
1722
|Key|Explanation|Default|
1823
|-------|---------------|-----------|
19-
|-i, --inputFile|the input file to process|*none*|
20-
|-n, --defaultName|default name for a route if none is specified in the input file|Unnamed Route|
21-
|-o, --outputFile|the output file to create<br/><br/>file type (e.g., kmz) will be derived from input file extension but can be overriden|*none*|
22-
|-t, --outputType|the type of output file to create. Must be one of *kml* or *kmz*| kml|
23-
|-p, --snapProcessor|the snap-to-route processor to use. Must be one of *Bing* or *Google*| Undefined |
24-
|-r, --runInteractive|force entry of all command line parameters regardless of whether or not they're specified in config file| false (not set)|
25-
|-k, --storeApiKey|prompt user for a snap-to-route processor's API key and store it, encrypted, in the app's user configuration| false (not set)|
24+
|-i<br/>--inputFile|the input file to process|*none*|
25+
|-n<br/>--defaultName|default name for a route if none is specified in the input file|Unnamed Route|
26+
|-o<br/>--outputFile|the output file to create<br/><br/>file type (e.g., kmz) will be derived from input file extension but can be overriden|*none*|
27+
|-t<br/>--outputType|the type of output file to create. Must be one of *kml* or *kmz*| kml|
28+
|-p<br/>--snapProcessor|the snap-to-route processor to use. Must be one of *Bing* or *Google*| Undefined |
29+
|-r<br/>--runInteractive|force entry of all command line parameters regardless of whether or not they're specified in config file| false (not set)|
30+
|-k<br/>--storeApiKey|prompt user for a snap-to-route processor's API key and store it, encrypted, in the app's user configuration| false (not set)|
2631

2732
### Configuration Files
2833
The app has a general configuration file, in its program directory, for

0 commit comments

Comments
 (0)