Initial documentation, minor tweaks.

Author: markolbert

GeoProcessor.sln

@@ -26,6 +26,17 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Test.GeoProcessor", "Test.G
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "GeoProcessorApp", "GeoProcessorApp\GeoProcessorApp.csproj", "{9F6D7226-328A-4FA4-9D56-9B68F240E127}"
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{46B961C5-1883-4706-8633-66984BA48596}"
+	ProjectSection(SolutionItems) = preProject
+		LICENSE.md = LICENSE.md
+		README.md = README.md
+	EndProjectSection
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "assets", "assets", "{62EB80C2-C53A-48CB-BC0D-67D4F40A5881}"
+	ProjectSection(SolutionItems) = preProject
+		docs\assets\tldr-console.png = docs\assets\tldr-console.png
+	EndProjectSection
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -78,6 +89,7 @@ Global
 		{70E3D3D7-4BFA-414E-806C-D007CD9342DC} = {5AD3F041-D553-492B-948D-E58BDA4373CF}
 		{64E230F2-1223-4FBE-BD97-A34152FAAF6C} = {5AD3F041-D553-492B-948D-E58BDA4373CF}
 		{6781EA78-CEEA-4B48-8D1E-E76CECE32A28} = {5AD3F041-D553-492B-948D-E58BDA4373CF}
+		{62EB80C2-C53A-48CB-BC0D-67D4F40A5881} = {46B961C5-1883-4706-8633-66984BA48596}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {FE44BCE1-11E4-4584-BACC-44570810FB77}

GeoProcessorApp/ConsoleExtensions.cs

@@ -50,7 +50,7 @@ public static string GetText(string curValue, string prompt, string? defaultValu
         {
             defaultValue ??= curValue;
 
-            Colors.WriteLine( "\nEnter ", prompt.Green(), " (current value is '".White(), curValue.Green(), "'): " );
+            Colors.WriteLine( "Enter ", prompt.Green(), " (current value is '".White(), curValue.Green(), "'): ");
             Console.Write("> ");
 
             var retVal = Console.ReadLine();
@@ -63,7 +63,7 @@ public static string GetText(string curValue, string? defaultValue, params Span[
             defaultValue ??= curValue;
 
             var promptList = prompts.ToList();
-            promptList.Insert( 0, "\nEnter".White() );
+            promptList.Insert( 0, "Enter ".White() );
             promptList.Add(" (current value is '".White()  );
             promptList.Add(curValue.Green()  );
             promptList.Add( "') :".White() );

GeoProcessorApp/Program.cs

@@ -9,7 +9,7 @@ namespace J4JSoftware.GeoProcessor
 {
     internal class Program
     {
-        public const string AppName = "GPS Track Processor";
+        public const string AppName = "GeoProcessor";
         public const string AppConfigFile = "appConfig.json";
         public const string UserConfigFile = "userConfig.json";
 

GeoProcessorApp/app/AppConfigValidator.cs

@@ -15,14 +15,14 @@ public void Validate( AppConfig config )
             ValidateProcessorType( config );
             ValidateAPIKey( config );
             ValidateInputFile( config );
-            ;
         }
 
         private void ValidateProcessorType( AppConfig config )
         {
             if( !config.RunInteractive && config.ProcessorType != ProcessorType.Undefined )
                 return;
 
+            Console.WriteLine();
             Colors.WriteLine( "\nProcessorType".Yellow(), " is undefined\n" );
 
             config.ProcessorType = ConsoleExtensions.GetEnum<ProcessorType>(
@@ -38,14 +38,16 @@ private void ValidateAPIKey( AppConfig config )
             if( !config.RunInteractive && !string.IsNullOrEmpty( config.APIKey ) )
                 return;
 
-            config.APIKey = ConsoleExtensions.GetText( config.APIKey, $"\n{config.ProcessorType} APIKey" );
+            Console.WriteLine();
+            config.APIKey = ConsoleExtensions.GetText( config.APIKey, $"{config.ProcessorType} APIKey" );
         }
 
         private void ValidateInputFile( AppConfig config )
         {
             if( !config.RunInteractive && !string.IsNullOrEmpty( config.InputFile.GetPath() ) )
                 return;
 
+            Console.WriteLine();
             var filePath = ConsoleExtensions.GetText( config.InputFile.GetPath(),
                 string.Empty,
                 "full path to input file ".Yellow() );

README.md

@@ -1,2 +1,83 @@
 # GeoProcessor
-a C# Net5 library and app for processing vehicle geolocation files, including snap-to-route.
+A C# Net5 library and app for processing vehicle geolocation files,
+snapping tracks/routes to roadways using the Bing or Google online
+snap-to-route processors (**note:** you'll need an account with Bing or Google to
+access those).
+
+### TL;DR
+The libarary source code should run anywhere Net5 is supported...but 
+I've only tested it, and the executable, on Windows 10.
+
+![tl;dr console image](docs/assets/tldr-console.png)
+
+You will need a Bing or Google API key for the library and program to
+work.
+
+### Command line options
+|Key|Explanation|Default|
+|-------|---------------|-----------|
+|-i, --inputFile|the input file to process|*none*|
+|-n, --defaultName|default name for a route if none is specified in the input file|Unnamed Route|
+|-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*|
+|-t, --outputType|the type of output file to create. Must be one of *kml* or *kmz*| kml|
+|-p, --snapProcessor|the snap-to-route processor to use. Must be one of *Bing* or *Google*| Undefined |
+|-r, --runInteractive|force entry of all command line parameters regardless of whether or not they're specified in config file| false (not set)|
+|-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)|
+
+### Configuration Files
+The app has a general configuration file, in its program directory, for
+configuring the logging system, specifying how close raw coordinates should
+be to each other to be merged, etc. It's a simple JSON file that looks
+like this:
+```json
+{
+  "Processors": {
+    "Distance": {
+      "MaxDistanceMultiplier": 3,
+      "MaxPointsPerRequest": -1,
+      "MaxSeparation": "100 ft"
+    },
+    "Bing": {
+      "MaxPointsPerRequest": 100,
+      "MaxSeparation": "2 km"
+    },
+    "Google": {
+      "MaxPointsPerRequest": 100,
+      "MaxSeparation": "2 km"
+    }
+  },
+  "Logging": {
+    "EventElements": "None",
+    "SourceRootPath": "C:\\Programming\\KMLProcessor\\",
+    "Channels": {
+      "Debug": {
+        "MinimumLevel": "Information"
+      },
+      "Console": {
+        "MinimumLevel": "Information"
+      }
+    }
+  }
+}
+```
+There's also a user configuration file which stores encrypted snap-to-route
+API keys, if those are defined by the user (i.e., not simply entered) 
+each time the program is run). It looks like this:
+```json
+{
+  "APIKeys": {
+    "Bing": {
+      "EncryptedValue": "CfDJ8DZjcBUs1sNEu98tAdCI1mAkm...omitted for brevity"
+    },
+    "Google": {
+      "EncryptedValue": "CfDJ8DZjcBUs1sNEu98tAdCI1mCS2...omitted for brevity"
+    }
+  }
+}
+```
+On Windows it's located at <br/>
+*C:\Users\\[username]\AppData\Local\J4JSoftware\GeoProcessor*.
+
+
+
+