Skip to content

Commit 035876e

Browse files
markolbertmarkolbert
committed
Added nuget readme files, changed app names to include company name
1 parent 8e73e05 commit 035876e

File tree

7 files changed

+102
-18
lines changed

7 files changed

+102
-18
lines changed

‎GeoProcessor.sln‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,36 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WPFUtilities", "..\Programm
2727
EndProject
2828
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "J4JCommandLine", "..\J4JCommandLine\J4JCommandLine\J4JCommandLine.csproj", "{2D02EC8B-3FFF-4DB7-9A67-17CB90FA01A2}"
2929
EndProject
30+
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{112A0C80-B0AB-4789-B8E6-896D8BCD5F78}"
31+
ProjectSection(SolutionItems) = preProject
32+
docs\apikeys.md = docs\apikeys.md
33+
docs\cmdline.md = docs\cmdline.md
34+
docs\config.md = docs\config.md
35+
docs\distance.md = docs\distance.md
36+
docs\library.md = docs\library.md
37+
docs\nposl-3.md = docs\nposl-3.md
38+
docs\nuget-consoleapp.md = docs\nuget-consoleapp.md
39+
docs\nuget-wpf.md = docs\nuget-wpf.md
40+
docs\win-config.md = docs\win-config.md
41+
docs\win-running-the-app.md = docs\win-running-the-app.md
42+
EndProjectSection
43+
EndProject
44+
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "assets", "assets", "{063D4109-68B1-4295-B963-ABE0E4C278BB}"
45+
ProjectSection(SolutionItems) = preProject
46+
docs\assets\tldr-console.png = docs\assets\tldr-console.png
47+
docs\assets\win-aborted.png = docs\assets\win-aborted.png
48+
docs\assets\win-completed.png = docs\assets\win-completed.png
49+
docs\assets\win-existing-file.png = docs\assets\win-existing-file.png
50+
docs\assets\win-good-to-go.png = docs\assets\win-good-to-go.png
51+
docs\assets\win-launch.png = docs\assets\win-launch.png
52+
docs\assets\win-options-changed.png = docs\assets\win-options-changed.png
53+
docs\assets\win-options-unsaved.png = docs\assets\win-options-unsaved.png
54+
docs\assets\win-options.png = docs\assets\win-options.png
55+
docs\assets\win-processing.png = docs\assets\win-processing.png
56+
docs\assets\win-processors.png = docs\assets\win-processors.png
57+
docs\assets\win-ready-to-begin.png = docs\assets\win-ready-to-begin.png
58+
EndProjectSection
59+
EndProject
3060
Global
3161
GlobalSection(SolutionConfigurationPlatforms) = preSolution
3262
Debug|Any CPU = Debug|Any CPU
@@ -88,6 +118,7 @@ Global
88118
{7F59F25F-4F4F-4361-8C6D-C52972F56269} = {5AD3F041-D553-492B-948D-E58BDA4373CF}
89119
{A1406166-3FAD-4675-8782-A48C3B63382F} = {5AD3F041-D553-492B-948D-E58BDA4373CF}
90120
{2D02EC8B-3FFF-4DB7-9A67-17CB90FA01A2} = {5AD3F041-D553-492B-948D-E58BDA4373CF}
121+
{063D4109-68B1-4295-B963-ABE0E4C278BB} = {112A0C80-B0AB-4789-B8E6-896D8BCD5F78}
91122
EndGlobalSection
92123
GlobalSection(ExtensibilityGlobals) = postSolution
93124
SolutionGuid = {FE44BCE1-11E4-4584-BACC-44570810FB77}

‎GeoProcessor/GeoProcessor.csproj‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,16 @@
1010
<Product>J4JSoftware GeoProcessing Library</Product>
1111
<Description>a library for processing GPX, KML and KMZ files, and snapping GPS tracks to roadways</Description>
1212
<Copyright>© Mark A. Olbert all rights reserved</Copyright>
13-
<PackageDescription>a library for processing GPX, KML and KMZ files, and snapping GPS tracks to roadways</PackageDescription>
1413
<RepositoryUrl>https://github.com/markolbert/GeoProcessor</RepositoryUrl>
15-
<PackageLicenseExpression>GPL-3.0-or-later</PackageLicenseExpression>
14+
<RepositoryType>git</RepositoryType>
15+
<Version>1.2.1.0</Version>
16+
<AssemblyVersion>1.2.1.0</AssemblyVersion>
1617
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
18+
<PackageDescription>a library for processing GPX, KML and KMZ files, and snapping GPS tracks to roadways</PackageDescription>
19+
<PackageLicenseExpression>GPL-3.0-or-later</PackageLicenseExpression>
1720
<PackageIcon>Diego nuspec.png</PackageIcon>
18-
<RepositoryType>git</RepositoryType>
19-
<Version>1.2.0.0</Version>
20-
<AssemblyVersion>1.2.0.0</AssemblyVersion>
21-
<PackageReleaseNotes>conformed to latest J4JCommandLine, DependencyInjection and J4JLogger APIs</PackageReleaseNotes>
21+
<PackageReleaseNotes>added nuget readme</PackageReleaseNotes>
22+
<PackageReadmeFile>nuget-geo.md</PackageReadmeFile>
2223
</PropertyGroup>
2324

2425
<ItemGroup>
@@ -43,6 +44,7 @@
4344
<Pack>True</Pack>
4445
<PackagePath></PackagePath>
4546
</None>
47+
<None Include="../docs/nuget-geo.md" Pack="true" PackagePath="/" />
4648
</ItemGroup>
4749

4850
</Project>

‎GeoProcessorApp/GeoProcessorApp.csproj‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
<PropertyGroup>
44
<OutputType>Exe</OutputType>
55
<TargetFramework>net5.0</TargetFramework>
6+
<AssemblyName>J4JSoftware.GeoProcessorApp</AssemblyName>
67
<RootNamespace>J4JSoftware.GeoProcessor</RootNamespace>
78
<Nullable>enable</Nullable>
89
<UserSecretsId>bddc2ef2-9330-48ea-b316-40fc738a4e28</UserSecretsId>
@@ -12,15 +13,16 @@
1213
<Product>GeoProcessor application</Product>
1314
<Description>processes GPX, KML and KMX files (optionally converting them) using Microsoft Bing or Google Maps route-snapping algorithms to produce driving routes that can be displayed in mapping programs.</Description>
1415
<Copyright>2021 Mark A. Olbert</Copyright>
15-
<PackageDescription>a console application for processing GPX, KML and KMZ files, and snapping GPS tracks to roadways</PackageDescription>
1616
<RepositoryUrl>https://github.com/markolbert/GeoProcessor</RepositoryUrl>
17-
<PackageLicenseExpression>GPL-3.0-or-later</PackageLicenseExpression>
17+
<RepositoryType>git</RepositoryType>
18+
<Version>1.2.1.0</Version>
19+
<AssemblyVersion>1.2.1.0</AssemblyVersion>
1820
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
21+
<PackageDescription>a console application for processing GPX, KML and KMZ files, and snapping GPS tracks to roadways</PackageDescription>
22+
<PackageLicenseExpression>GPL-3.0-or-later</PackageLicenseExpression>
1923
<PackageIcon>Diego nuspec.png</PackageIcon>
20-
<RepositoryType>git</RepositoryType>
21-
<Version>1.2.0.0</Version>
22-
<AssemblyVersion>1.2.0.0</AssemblyVersion>
23-
<PackageReleaseNotes>conformed to latest J4JCommandLine, DependencyInjection and J4JLogger APIs</PackageReleaseNotes>
24+
<PackageReleaseNotes>added nuget readme, added company name to app name</PackageReleaseNotes>
25+
<PackageReadmeFile>nuget-consoleapp.md</PackageReadmeFile>
2426
</PropertyGroup>
2527

2628
<ItemGroup>
@@ -35,6 +37,7 @@
3537
<None Update="appConfig.json">
3638
<CopyToOutputDirectory>Always</CopyToOutputDirectory>
3739
</None>
40+
<None Include="../docs/nuget-consoleapp.md" Pack="true" PackagePath="/" />
3841
</ItemGroup>
3942

4043
<ItemGroup>

‎GeoProcessorWPF/GeoProcessorWPF.csproj‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
<PropertyGroup>
44
<OutputType>WinExe</OutputType>
55
<TargetFramework>net5.0-windows</TargetFramework>
6+
<AssemblyName>J4JSoftware.GeoProcessorWPF</AssemblyName>
67
<UseWPF>true</UseWPF>
78
<RootNamespace>J4JSoftware.GeoProcessor</RootNamespace>
89
<Nullable>enable</Nullable>
@@ -12,15 +13,16 @@
1213
<Product>J4JSoftware Windows GeoProcessor</Product>
1314
<Description>a Windows app for processing GPX, KML and KMZ files, and snapping GPS tracks to roadways</Description>
1415
<Copyright>2021 Mark A. Olbert</Copyright>
15-
<PackageDescription>a WPF application for processing GPX, KML and KMZ files, and snapping GPS tracks to roadways</PackageDescription>
1616
<RepositoryUrl>https://github.com/markolbert/GeoProcessor</RepositoryUrl>
17-
<PackageLicenseExpression>GPL-3.0-or-later</PackageLicenseExpression>
17+
<RepositoryType>git</RepositoryType>
18+
<Version>1.2.1.0</Version>
19+
<AssemblyVersion>1.2.1.0</AssemblyVersion>
1820
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
21+
<PackageDescription>a WPF application for processing GPX, KML and KMZ files, and snapping GPS tracks to roadways</PackageDescription>
22+
<PackageLicenseExpression>GPL-3.0-or-later</PackageLicenseExpression>
1923
<PackageIcon>Diego nuspec.png</PackageIcon>
20-
<RepositoryType>git</RepositoryType>
21-
<Version>1.2.0.0</Version>
22-
<AssemblyVersion>1.2.0.0</AssemblyVersion>
23-
<PackageReleaseNotes>conformed to latest J4JCommandLine, DependencyInjection and J4JLogger APIs</PackageReleaseNotes>
24+
<PackageReleaseNotes>added nuget readme</PackageReleaseNotes>
25+
<PackageReadmeFile>nuget-wpf.md</PackageReadmeFile>
2426
</PropertyGroup>
2527

2628
<ItemGroup>
@@ -63,6 +65,7 @@
6365
<None Update="license.txt">
6466
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
6567
</None>
68+
<None Include="../docs/nuget-wpf.md" Pack="true" PackagePath="/" />
6669
</ItemGroup>
6770

6871
<ItemGroup>

‎docs/nuget-consoleapp.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# GeoProcessorApp
2+
3+
A C# Net5 command line 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).
4+
5+
The library and apps are licensed under the GNU GPL-v3.0 (or later) license.
6+
7+
For more details consult the [github documentation](https://github.com/markolbert/GeoProcessor).
8+
9+
Certain options can be configured from either the command line or from a configuration file.
10+
11+
|Key |Explanation |Default |
12+
|---------------|---------------|-----------|
13+
|-i, --inputFile|the input file to process|*none*|
14+
|-n, --defaultName|default name for a route if none is specified in the input file|Unnamed Route|
15+
|-o, --outputFile|the output file to create file type (e.g., kmz) will be derived from input file extension but can be overriden|*none*|
16+
|-t, --outputType|the type of output file to create. Must be one of *kml* or *kmz*| kml|
17+
|-p, --snapProcessor|the snap-to-route processor to use. Must be one of *Bing* or *Google*| Undefined |
18+
|-r, --runInteractive|force entry of all command line parameters regardless of whether or not they're specified in config file| false (not set)|
19+
|-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)|
20+
21+
File names should include the path to the file, either relative to the current directory or the full path.
22+
23+
File names or default route names containing spaces need to be wrapped in quotes (").

‎docs/nuget-geo.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# GeoProcessor
2+
3+
A C# Net5 library 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).
4+
5+
The library and apps are licensed under the GNU GPL-v3.0 (or later) license.
6+
7+
For more information consult the [github documentation](https://github.com/markolbert/GeoProcessor).

‎docs/nuget-wpf.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# GeoProcessorWPF
2+
3+
After you've properly configured the app you can select a file to process by clicking the **...** control to the right of the **Input File** field. This will display a normal Windows file selection dialog which you can use to choose a file to process.
4+
5+
The app only knows how to process **GPX**, **KML** and **KMZ** files.
6+
7+
The app can output its results to either a **KML** or **KMZ** file. **KMZ** files are simply compressed/zipped **KML** files, so they're smaller but you can't examine them in a text editor.
8+
9+
After you select a file the **Process File** button becomes enabled. You can select the snap-to-route processor to use with the **Route Snapping Processor** dropdown. Only processors which have a defined API key (or don't require one) will be available as choices.
10+
11+
If the output file exists you'll be asked to confirm you want to overwrite it. Assuming you do, or if it doesn't already exist, a new window will open tracking the processing.
12+
13+
A count of points processed and various messages will then appear. Don't be surprised if the **Points Processed** doesn't match the number of points written to the output file. That's normal, because the snap-to-route processor adds additional points to make the final route "smooth" and match (mostly) actual roads.
14+
15+
You can abort the effort by clicking the **Abort** button. It may take a second or two for the processing to shut down.

0 commit comments

Comments
 (0)