Releasing updates to template and library (#69)

.editorconfig

@@ -1,17 +1,20 @@
-# Base file "borrowed" from the Fritz.StreamTools project
-# Source: https://github.com/csharpfritz/Fritz.StreamTools/blob/25d4dff4ac39c456fc9413f25ccc1a4cb269a1c1/.editorconfig
-
-root = true
-
-[*]
-end_of_line = crlf
-indent_style = tab
-indent_size = 2
-trim_trailing_whitespace = true
-insert_final_newline = true
-
-[*.cs]
-csharp_style_var_for_built_in_types = true:error
-csharp_style_var_when_type_is_apparent = true:error
-csharp_style_var_elsewhere = true:error
-csharp_prefer_braces = true
+# Base file "borrowed" from the Fritz.StreamTools project
+# Source: https://github.com/csharpfritz/Fritz.StreamTools/blob/25d4dff4ac39c456fc9413f25ccc1a4cb269a1c1/.editorconfig
+
+root = true
+
+[*]
+end_of_line = crlf
+indent_style = tab
+indent_size = 2
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.cs]
+csharp_style_var_for_built_in_types = true:error
+csharp_style_var_when_type_is_apparent = true:error
+csharp_style_var_elsewhere = true:error
+csharp_prefer_braces = true
+
+[*.sh]
+end_of_line = lf

.gitignore

@@ -221,7 +221,7 @@ ClientBin/
 *.publishsettings
 orleans.codegen.cs
 
-# Including strong name files can present a security risk 
+# Including strong name files can present a security risk
 # (https://github.com/github/gitignore/pull/2483#issue-259490424)
 #*.snk
 
@@ -317,7 +317,7 @@ __pycache__/
 # OpenCover UI analysis results
 OpenCover/
 
-# Azure Stream Analytics local run output 
+# Azure Stream Analytics local run output
 ASALocalRun/
 
 # MSBuild Binary and Structured Log
@@ -326,5 +326,68 @@ ASALocalRun/
 # NVidia Nsight GPU debugger configuration file
 *.nvuser
 
-# MFractors (Xamarin productivity tool) working folder 
+# MFractors (Xamarin productivity tool) working folder
 .mfractor/
+
+# Code coverage generate by coverlet
+**/coverage.json
+**/coverage.cobertura.xml
+**/lcov.info
+
+# Created by https://www.gitignore.io/api/osx,windows
+# Edit at https://www.gitignore.io/?templates=osx,windows
+
+### OSX ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# End of https://www.gitignore.io/api/osx,windows

.vscode/launch.json

@@ -0,0 +1,26 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Debug Sample Plugin",
+            "type": "coreclr",
+            "request": "launch",
+            "preLaunchTask": "build",
+            "program": "${workspaceFolder}/src/SamplePlugin/bin/Debug/netcoreapp2.2/SamplePlugin.dll",
+            "args": [],
+            "cwd": "${workspaceFolder}/src",
+            "console": "internalConsole",
+            "stopAtEntry": false,
+            "internalConsoleOptions": "openOnSessionStart"
+        },
+        {
+            "name": ".NET Core Attach",
+            "type": "coreclr",
+            "request": "attach",
+            "processId": "${command:pickProcess}"
+        }
+    ]
+}

.vscode/tasks.json

@@ -15,6 +15,23 @@
                 "reveal": "always"
             },
             "problemMatcher": "$msCompile"
-        }
+        },
+        {
+          "label": "TestWithCoverage",
+          "command": "dotnet",
+          "type": "process",
+          "args": [
+           "test",
+           "/p:CollectCoverage=true",
+           "/p:CoverletOutputFormat=lcov",
+           "/p:CoverletOutput=./lcov",
+           "${workspaceRoot}/src/StreamDeckLib.Test/StreamDeckLib.Test.csproj"
+          ],
+          "problemMatcher": "$msCompile",
+          "group": {
+           "kind": "test",
+           "isDefault": true
+          }
+         }
     ]
-}
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Fritz and Friends
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,7 +1,53 @@
 # StreamDeckToolkit
 
-![](https://dev.azure.com/FritzAndFriends/StreamDeckTools/_apis/build/status/StreamDeckTools-CI)
+[![Build status](https://dev.azure.com/FritzAndFriends/StreamDeckTools/_apis/build/status/StreamDeckTools-CI)](https://dev.azure.com/FritzAndFriends/StreamDeckTools/_build/latest?definitionId=8)  ![](https://vsrm.dev.azure.com/FritzAndFriends/_apis/public/Release/badge/00a6d40c-eb0d-4aa8-a405-d13d03317ca9/1/1)  [![NuGet](https://img.shields.io/nuget/v/StreamDeckLib.svg)](https://www.nuget.org/packages/StreamDeckLib/)
 
-![](https://vsrm.dev.azure.com/FritzAndFriends/_apis/public/Release/badge/00a6d40c-eb0d-4aa8-a405-d13d03317ca9/1/1)
+![](https://img.shields.io/azure-devops/tests/FritzAndFriends/StreamDeckTools/8/dev.svg)
 
-![](https://img.shields.io/nuget/v/StreamDeckLib.svg)
+[Intellicode Model](https://prod.intellicode.vsengsaas.visualstudio.com/get?m=EE5419D495BE49528606139DA3ADC687)
+
+## What Is This?
+
+This is a template to help create plugins for the [Elgato Stream Deck][Stream Deck], using the [Stream Deck SDK][] with [Dotnet Core][].
+
+## Pre-Requisites
+
+In order to make use of this template, you will need to have the [Dotnet Core SDK][] (version 2.2.100 or above) installed on your development machine.
+
+While not absolutely necessary, it is **strongly** recommended to have the [Stream Deck Software][] installed, to be able to perform some integration testing of your plugin.
+
+## Install Project Template
+
+### From File System
+
+Useful for local testing of the template when developing.
+
+    dotnet new -i /StreamDeckToolkit/Templates/StreamDeck.PluginTemplate.Csharp/
+
+Uninstall the local template by running.
+
+    dotnet new -u /StreamDeckToolkit/Templates/StreamDeck.PluginTemplate.Csharp/
+
+### From NuGet
+
+    dotnet add package StreamDeckPluginTemplate
+    - OR -
+    Install-Package StreamDeckPluginTemplate -Version 0.2.286
+
+## Using the Template
+
+Once the template is installed, open a terminal and create a new project.
+
+    dotnet new streamdeck-plugin -n FirstPlugin
+
+Or create a directory in a location of your choice, change to that directory and run the command, which will inherit the directory name as the project name.
+
+    dotnet new streamdeck-plugin
+
+<!-- Reference Links -->
+
+[Dotnet Core]: https://dotnet.microsoft.com/ "Free, cross-platform application framework"
+[Dotnet Core SDK]: https://get.dot.net/ "Download the Dotnet Core SDK or Runtime"
+[Stream Deck]: https://www.elgato.com/gaming/stream-deck/ "Elgato's Stream Deck product page"
+[Stream Deck SDK]: https://developer.elgato.com/documentation/stream-deck "Elgato's Stream Deck SDK documentation and reference site"
+[Stream Deck Software]: https://www.elgato.com/gaming/downloads "Download the Stream Deck desktop software"

StreamDeckToolkit.code-workspace

@@ -0,0 +1,26 @@
+{
+	"folders": [
+		{
+			"path": "."
+		}
+	],
+	"settings": {
+		"files.exclude": {
+			"**/.vs/": true,
+			"**/obj/": true,
+			"**/bin/": true,
+			"**/TestResults/": true,
+			"**/coverage.json": true,
+			"**/coverage.cobertura.xml": true,
+			"**/lcov.info": true
+		},
+		"dotnet-test-explorer.testProjectPath": "/src/StreamDeckLib.Test"
+	},
+	"extensions": {
+		"recommendations": [
+			"ms-vscode.csharp",
+			"ryanluker.vscode-coverage-gutters",
+			"formulahendry.dotnet-test-explorer"
+		]
+	}
+}

Templates/StreamDeck.PluginTemplate.Csharp/StreamDeckPluginTemplate.nuspec

@@ -4,10 +4,10 @@
     <id>StreamDeckPluginTemplate</id>
     <version>$version$</version>
     <authors>csharpfritz</authors>
-    <description>Templates for creating StreamDeck plugin.</description>
+    <description>Templates for creating a plugin for the Elgato (Corsair) Stream Deck</description>
     <language>en-US</language>
-    <projectUrl>https://github.com/csharpfritz/StreamDeck_First</projectUrl>
-    <licenseUrl>https://github.com/csharpfritz/StreamDeck_First/blob/master/LICENSE</licenseUrl >
+    <projectUrl>https://github.com/FritzAndFriends/StreamDeckToolkit/</projectUrl>
+    <licenseUrl>https://github.com/FritzAndFriends/StreamDeckToolkit/blob/master/LICENSE</licenseUrl >
     <copyright></copyright>
     <tags>dotnet templates</tags>
     <packageTypes>
@@ -17,4 +17,4 @@
   <files>
     <file src="content/**" target="content/" />
   </files>
-</package>
+</package>