Added installation notes

noodnik2 · Mar 2, 2021 · c4f188d · c4f188d
1 parent 6a17b79
commit c4f188d
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 90 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -2,10 +2,10 @@ name: Build
 
 on:
   push:
-    branches:
-      - 210227-cicr-reset-test
+#    branches:
+#      - 210227-cicr-reset-test
     tags:
-      - '*'
+      - '*-release'
 
 jobs:
 
@@ -57,17 +57,11 @@ jobs:
       with:
         tag_name: ${{ steps.build-manifest.outputs.BUILD_TAG }}
         release_name: Release ${{ steps.build-manifest.outputs.BUILD_TAG }}
-#    - name: Add Release Manifest
-#      run: |
-#        echo "Release ${BUILD_TAG}-${BUILD_BRANCH}-${RELEASE_TIME}" > Release/build_release_manifest
-#    - name: Build Release Deliverable
-#      uses: thedoctor0/zip-release@master
-#      with:
-#        path: FS2020PlanePath/bin/Release
-#        filename: PilotPathRecorder-n2.zip
+
     - name: Build Release Deliverable
       run: |
         Compress-Archive -Path FS2020PlanePath\bin\Release\* -DestinationPath PilotPathRecorder-n2.zip
+
     - name: Upload Release Deliverable
       id: upload_release_asset
       uses: actions/upload-release-asset@v1
@@ -79,81 +73,3 @@ jobs:
         asset_name: PilotPathRecorder-n2-${{ steps.build-manifest.outputs.BUILD_TAG }}.zip
         asset_content_type: application/zip
 
-#  release:
-#    name: Create Release
-#    runs-on: ubuntu-latest
-#    needs: build
-#    steps:
-#      - uses: actions/checkout@v2
-#      - name: Get Current Tag
-##          echo "BUILD_TAG=$(git describe --tags $(git rev-list --tags --max-count=1))" >> $GITHUB_ENV
-#        run: |
-#          echo "BUILD_TAG=tn2" >> $GITHUB_ENV
-#          echo "BUILD_BRANCH=$(git rev-parse --abbrev-ref HEAD)" >> $GITHUB_ENV
-#          echo "RELEASE_TIME=$(date +%y%m%d%H%M)" >> $GITHUB_ENV
-#          echo "BUILD_TAG=${{ env.BUILD_TAG }}, BUILD_BRANCH=${{ env.BUILD_BRANCH }}, RELEASE_TIME=${{ env.RELEASE_TIME }}"
-#      - name: Download Build Artifacts
-#        uses: actions/download-artifact@v2
-#        with:
-#          name: MSFS2020-PilotPathRecorder-n2
-#      - name: Create GitHub Release
-#        id: create_release
-#        uses: actions/create-release@v1
-#        env:
-#          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-#        with:
-#          tag_name: ${{ env.BUILD_BRANCH }}-${{ env.RELEASE_TIME }}
-#          release_name: Release ${{ env.BUILD_TAG }}-${{ env.BUILD_BRANCH }}-${{ env.RELEASE_TIME }}
-#      - name: Add Release Manifest
-#        run: |
-#          echo "Release ${BUILD_TAG}-${BUILD_BRANCH}-${RELEASE_TIME}" > Release/build_release_manifest
-#      - name: Build Release Deliverable
-#        uses: thedoctor0/zip-release@master
-#        with:
-#          path: Release
-#          filename: PilotPathRecorder-n2.zip
-#      - name: Upload Release Deliverable
-#        id: upload_release_asset
-#        uses: actions/upload-release-asset@v1
-#        env:
-#          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-#        with:
-#          upload_url: ${{ steps.create_release.outputs.upload_url }}
-#          asset_path: PilotPathRecorder-n2.zip
-#          asset_name: PilotPathRecorder-n2-${{ env.BUILD_TAG }}-${{ env.BUILD_BRANCH }}-${{ env.RELEASE_TIME }}.zip
-#          asset_content_type: application/zip
-
-#  release:
-#    name: Create Release
-#    runs-on: ubuntu-latest
-#    needs: build
-#    steps:
-#      - name: Download Build Artifacts
-#        uses: actions/download-artifact@v2
-#        with:
-#          name: MSFS2020-PilotPathRecorder-n2
-#      - name: List Artifacts
-#        run: ls -ltr
-#      - name: Create GitHub Release
-#        id: create_release
-#        uses: actions/create-release@v1
-#        env:
-#          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-#        with:
-#          tag_name: ${{ github.ref }}-${{ github.run_number }}
-#          release_name: Release ${{ github.ref }}-${{ github.run_number }}
-#      - name: Build Release Deliverable
-#        uses: thedoctor0/zip-release@master
-#        with:
-#          filename: PilotPathRecorder-n2.zip
-#      - name: Upload Release Deliverable
-#        id: upload_release_asset
-#        uses: actions/upload-release-asset@v1
-#        env:
-#          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-#        with:
-#          upload_url: ${{ steps.create_release.outputs.upload_url }}
-#          asset_path: PilotPathRecorder-n2.zip
-##          asset_name: PilotPathRecorder-n2-${{ github.ref }}-${{ github.run_number }}.zip
-#          asset_name: PilotPathRecorder-n2-${{ github.run_number }}.zip
-#          asset_content_type: application/zip
diff --git a/README-installation.md b/README-installation.md
@@ -0,0 +1,29 @@
+# Installation Notes
+
+These notes are aimed at answering the most frequent questions
+arising for new users.
+
+Please let us know if your question isn't answered below!
+
+## "What are the prerequisites?"
+
+- This version of `MSFS2020-PilotPathRecorder` has been successfully
+installed on [Windows 10](https://www.microsoft.com/en-us/windows/get-windows-10),
+and requires a standard installation of the 
+[desktop version of Google Earth](https://www.google.com/earth/versions/)
+(e.g., try version 7.3 if you're unsure) to be associated with the `.kml`
+file extension.
+
+## "How do I install and run it?"
+
+1. Download the `PilotPathRecorder*.zip` deliverable build asset from a 
+   [release](https://github.com/noodnik2/MSFS2020-PilotPathRecorder/releases).
+   If you haven't any reason to prefer a specific release, choose the latest. 
+1. Unzip the release into a new application folder, from where you will run it.
+   Note that the application will need write access to this folder (e.g., in
+   order to store its state) when it runs.
+1. To run the application, double-click or otherwise invoke the file
+   named `PilotPathRecorder.exe`, which you'll find within the unzipped
+   folder.  It can be helpful to create a link to this location (e.g.,
+   on your desktop) for easier access.
+
diff --git a/README.md b/README.md
@@ -21,7 +21,8 @@ This is a stand-alone application that is run outside of Microsft Flight Simulat
 # Version History
 v1.3.0n2
 - Added ["Live Cam" support](README-kmlcam.md)
-- Added [Developer Notes](README-dev.md) doc
+- Added [Installation Notes](README-installation.md)
+- Added [Developer Notes](README-dev.md)
 
 v1.3.0
 - Added ability to automatically start and stop the recorder based on flight ground speed. This way you will never forget to log your flight.