[478] update docs for v4

.github/workflows/pr-check.yml

@@ -35,24 +35,6 @@ jobs:
     - name: Test
       run: dotnet test
 
-  publish-windows-console-exe-dist:
-    name: Publish Windows Console Exe Distribution
-    runs-on: 'windows-latest'
-    needs: build-and-test
-    strategy:
-      matrix:
-        dotnet: [ '7.0' ]
-        os: [ 'win10-x64' ]
-
-    steps:
-
-    - uses: actions/checkout@v3
-    - name: Publish Windows Console Exe Distribution
-      uses: ./.github/actions/publish-console-exe-dist
-      with:
-        dotnet-version: ${{ matrix.dotnet }}
-        os: ${{ matrix.os }}
-
   publish-ui-dist:
     name: Publish UI Distribution
     runs-on: 'windows-latest'

.github/workflows/publish-latest.yaml

@@ -38,23 +38,6 @@ jobs:
                 secret_docker_password: ${{ secrets.DOCKER_PASSWORD }}
                 secret_github_package: ${{ secrets.GH_PACKAGE_SECRET}}
 
-  publish-windows-console-exe-dist:
-      name: Publish Windows Console Exe Distribution
-      runs-on: 'windows-latest'
-      strategy:
-        matrix:
-          dotnet: [ '7.0' ]
-          os: [ 'win10-x64' ]
-
-      steps:
-
-      - uses: actions/checkout@v3
-      - name: Publish Windows Console Exe Distribution
-        uses: ./.github/actions/publish-console-exe-dist
-        with:
-          dotnet-version: ${{ matrix.dotnet }}
-          os: ${{ matrix.os }}
-
   publish-ui-dist:
     name: Publish UI Distribution
     runs-on: 'windows-latest'

.github/workflows/publish-release.yaml

@@ -45,27 +45,6 @@ jobs:
           secret_docker_password: ${{ secrets.DOCKER_PASSWORD }}
           secret_github_package: ${{ secrets.GH_PACKAGE_SECRET}}
 
-  publish-windows-console-exe-dist:
-    name: Publish Windows Console Distribution
-    runs-on: 'windows-latest'
-    outputs:
-      artifact: ${{ steps.win-exe-create-artifact.outputs.artifact }}
-    strategy:
-      matrix:
-        dotnet: [ '7.0' ]
-        #os: [ 'win10-x64', 'osx-x64' ] # osx signing issue, mac wont run the executable
-        os: [ 'win10-x64' ]
-
-    steps:
-
-    - uses: actions/checkout@v3
-    - name: Publish Windows Console Exe Distribution
-      uses: ./.github/actions/publish-console-exe-dist
-      id: win-exe-create-artifact
-      with:
-        dotnet-version: ${{ matrix.dotnet }}
-        os: ${{ matrix.os }}
-
   publish-ui-dist:
     name: Publish UI Distribution
     runs-on: 'windows-latest'
@@ -90,14 +69,8 @@ jobs:
 
   create-gh-release:
     runs-on: ubuntu-latest
-    needs: [publish-windows-console-exe-dist, publish-ui-dist, publish-docker-images ]
+    needs: [publish-ui-dist, publish-docker-images ]
     steps:
-      - name: Create Zip for Win EXE Release Artifact
-        uses: papeloto/action-zip@v1
-        with:
-          files: ${{ needs.publish-windows-console-exe-dist.outputs.artifact }}
-          dest: /dist/console_win_${{ github.event.inputs.version }}.zip
-
       - name: Create Zip for Win UI Release Artifact
         uses: papeloto/action-zip@v1
         with:

docs/.markdownlint.json

@@ -0,0 +1,4 @@
+{
+    "MD013": false,
+    "MD025": false
+}

docs/features.md

@@ -42,7 +42,7 @@ Convert, Backup, and Sync.
 
 ## Screenshots
 
-#### Converted and imported Cycling Workout
+### Converted and imported Cycling Workout
 
 ![Converted Cycling Workout](https://github.com/philosowaffle/peloton-to-garmin/raw/master/images/example_cycle.png?raw=true "Converted Cycling Workout")
 
@@ -58,5 +58,6 @@ Convert, Backup, and Sync.
 
 ![Laps](https://github.com/philosowaffle/peloton-to-garmin/raw/master/images/example_laps.png?raw=true "Laps")
 
-### Web UI
+### UI
+
 ![Web UI Demo](https://github.com/philosowaffle/peloton-to-garmin/raw/master/images/p2g_webui_demo.gif?raw=true "Web UI Demo")

docs/install/windows.md

@@ -7,42 +7,47 @@ nav_order: 3
 
 # Windows
 
-For convenience a compiled windows executable is provided. This can easily be downloaded and run on your machine.
+With P2G v4, there is now a Windows GUI application available for download. P2G does not install anything to your computer, everything it needs to run is self-contained in the folder you downloaded.  This includes all of your settings and other configuration files.  For this reason,
+
+1. You can always download and run a newer version of P2G without any risk of breaking your existing version.
+1. Since P2G does not yet support multiple users, but you can have two instances of P2G on the same computer, each setup for a different user
+1. To uninstall P2G simply delete its folder
+1. You may wish to create a Desktop shortcut to the application for convenience
+
+## Install
 
 1. Download and unzip the [latest stable release](https://github.com/philosowaffle/peloton-to-garmin/releases)
-1. In the unzipped directory find the `configuration.local.json` and open it in a text editor of your choice
-    1. Be sure to set your usernames and passwords in Garmin and Peloton config sections respectively.
-    1. Save and close the file
-1. Find the `ConsoleClient.exe`
+1. Find the `ClientUI.exe`
 1. Double click to run it!
 
-You can learn more about customizing your configuration file over in the [Configuration Section]({{ site.baseurl }}{% link configuration/index.md %}).
+You can learn more about customizing your configuration over in the [Configuration Section]({{ site.baseurl }}{% link configuration/index.md %}).
 
 ## Updating
 
 1. Download and unzip the [latest stable release](https://github.com/philosowaffle/peloton-to-garmin/releases)
 1. In the unzipped directory replace the `configuration.local.json` with your previous `configuration.local.json` file
-1. Find the `ConsoleClient.exe`
+1. In the unzipped directory copy over th `data` folder from your previous P2G install folder, this will preserve your settings
+1. Find the `ClientUI.exe`
 1. Double click to run it!
 
 ## Rolling back to a previous version
 
 1. Find the release you want from the [releases page](https://github.com/philosowaffle/peloton-to-garmin/releases)
 1. Download and unzip the Windows exe from that relase (found in the `Assets` section)
 1. In the unzipped directory replace the `configuration.local.json` with your previous `configuration.local.json` file
-1. Find the `ConsoleClient.exe`
+1. In the unzipped directory copy over th `data` folder from your previous P2G install folder, this will preserve your settings
+1. Find the `ClientUI.exe`
 1. Double click to run it!
 
 ## Available Versions
 
 P2G provides two different versions of the executable you can choose between:
 
 1. [The latest stable version](https://github.com/philosowaffle/peloton-to-garmin/releases)
-1. [The latest dev version](https://github.com/philosowaffle/peloton-to-garmin/actions/workflows/publish_distros_latest.yml)
+1. [The latest dev version](https://github.com/philosowaffle/peloton-to-garmin/actions/workflows/publish-latest.yaml)
     1. Click on the first item in the list with a green checkmark, this will be the latest successful build.
     1. On the summary page, at the bottom you will see a section called `Artifacts` with various builds attached. Click on one of these builds to download for your operating system.
 
 ## Limitations
 
 1. Does not truly run in the background, the program must be minimized to the the task bar if using it to automatically sync, and you must manually restart it if your computer reboots
-1. No GUI....yet ;)