Update release.yaml workflow to generate checksums and create a draft…

… release

.github/workflows/release.yaml

@@ -74,7 +74,6 @@ jobs:
           shopt -s extglob
           shopt -s nullglob
 
-          root_dir="$(pwd)"
           commit_hash="${GITHUB_SHA:0:9}"
 
           variants=(
@@ -83,15 +82,14 @@ jobs:
             'windows'
           )
 
-          mkdir -p "${root_dir}/uploads"
+          mkdir -p "${{ github.workspace }}/uploads"
 
           for variant in "${variants[@]}"; do
 
             candidates=(*-${variant}/@(*))
 
             for candidate in "${candidates[@]}"; do
-              cp "${candidate}" "${root_dir}/uploads/scoresight-${variant}-${GITHUB_REF_NAME}-${commit_hash}.${candidate##*.}"
-              cp "${candidate}" "${root_dir}/uploads/scoresight-${variant}-latest.${candidate##*.}"
+              cp "${candidate}" "${{ github.workspace }}/uploads/scoresight-${variant}-${GITHUB_REF_NAME}.${candidate##*.}"
             done
           done
 
@@ -111,19 +109,19 @@ jobs:
 
           echo "### Checksums" > ${{ github.workspace }}/CHECKSUMS.txt
           # find the files from the above step and generate checksums
-          for file in ${{ github.workspace }}/scoresight-*; do
+          for file in ${{ github.workspace }}/uploads/scoresight-*; do
             echo "    ${file##*/}: $(sha256sum "${file}" | cut -d " " -f 1)" >> ${{ github.workspace }}/CHECKSUMS.txt
           done
 
       - name: Create Release 🛫
         if: fromJSON(steps.check.outputs.validTag)
         id: create_release
-        uses: softprops/action-gh-release@v1
+        uses: softprops/action-gh-release@v2
         with:
           draft: true
           body_path: ${{ github.workspace }}/CHECKSUMS.txt
           files: |
-            ${{ github.workspace }}/scoresight-*.zip
-            ${{ github.workspace }}/scoresight-*.exe
-            ${{ github.workspace }}/scoresight-*.dmg
-            ${{ github.workspace }}/scoresight-*.tar
+            ${{ github.workspace }}/uploads/scoresight-*.zip
+            ${{ github.workspace }}/uploads/scoresight-*.exe
+            ${{ github.workspace }}/uploads/scoresight-*.dmg
+            ${{ github.workspace }}/uploads/scoresight-*.tar

INSTALL.md

@@ -0,0 +1,51 @@
+# How to Download and Install ScoreSight
+
+Downloading ScoreSight for your operating system is a simple process. Visit the [releases](https://github.com/occ-ai/scoresight/releases) to find the download links.
+
+## Windows
+
+If your browser alerts you for a virus warning when downloading ScoreSight like so:
+
+![alt text](docs/image.png)
+
+This is a false alarm issue by Microsoft and Google. To bypass this alarm and download the file you may need to temporarily disable the Windows Defender that issues the alarm and prevents the file download. This is simple to do, and you can undo it right after downloading ScoreSight to resume protection of your PC.
+
+Open Windows Security by pressing the Windows Key and enter "Windows Security"
+
+![alt text](docs/image-1.png)
+
+Click "App and Browser Control"
+
+![alt text](docs/image-2.png)
+
+Click "Reputation Based protection"
+
+![alt text](docs/image-3.png)
+
+And disable the "Check Apps and Files" and "SmartScreen for Microsoft Edge" options.
+
+![alt text](docs/image-4.png)
+
+Then download ScoreSight again. This time the download should go through and the file will be available on your PC. Re-enable the two options above to resume protecting your computer from malicious software.
+
+If you are having problems with the download still please reach out on [email protected]
+
+To install on Windows, simply click the .zip file and then the .exe setup installer inside.
+
+![alt text](docs/image-5.png)
+
+Once the setup is complete, ScoreSight will be available as an application.
+
+## Mac OS
+
+On Mac OS ScoreSight comes as packaged .app application which doesn't need installation.
+
+Download the .dmg archive:
+
+![alt text](docs/image-6.png)
+
+Double click and optionally drag the scoresight.app file to your Applications folder:
+
+![alt text](docs/image-7.png)
+
+ScoreSight should now be available as an application.

README.md

@@ -19,7 +19,11 @@ Videos and tutorials will be provided shortly.
 
 ## Installation
 
-See the releases page for downloadable executables and installers.
+See the [releases](https://github.com/occ-ai/scoresight/releases) page for downloadable executables and installers.
+
+See the [Install Guide](INSTALL.md) for help with installation.
+
+## Build from Source
 
 ### Prerequisites