adding readme and previews

README.md

@@ -1,2 +1,39 @@
-# FocusVolumeControlPlugin
+# Focus Volume Control Plugin
 
+A plugin for the Stream Deck+ to control the volume of the focused application.
+
+## Description
+
+This Stream Deck plugin utilizes the Stream Deck+ encoders and screen to allow you to control the volume of the focused application.
+Application volume is changed with the windows volume mixer.
+
+Unlike faders or potentiometers, the encoders of the Stream Deck+ spin infinitely in either direction. Which means when you change your focused application, you don't have to worry about desynchronization with the current app.
+The screen updates to show the name/icon of the app so that you can always know what you're about to change.
+
+![Focus volume control plugin preview](previews/preview.png?raw=true)
+
+## Developing
+
+build the solution with visual studio
+run `install.bat <debug | release>`
+
+to debug, attach to the FocusVolumeControl running process
+
+
+There is also a secondary sound browser project which can be used for viewing information about processes and how the algorithm matches them to volume mixers
+
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for detiails
+
+## Acknowledgements
+
+Inspiration, code snippets, etc.
+* [BinRaider's streamdeck-tools](https://github.com/BarRaider/streamdeck-tools)
+* [Deej](https://github.com/omriharel/deej)
+* [Stream Deck Developer Guide](https://docs.elgato.com/sdk/plugins/getting-started)
+* [CoreAudio](https://github.com/morphx666/CoreAudio)
+
+Inspiration
+* [PCPanel](https://www.getpcpanel.com/)

src/FocusVolumeControl/FocusVolumeControl.csproj

@@ -77,40 +77,10 @@
     </None>
   </ItemGroup>
   <ItemGroup>
-    <Content Include="Images\categoryIcon%402x.png">
+    <Content Include="$(SolutionDir)..\previews\**\*" Link="previews\%(Filename)%(Extension)">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </Content>
-    <Content Include="Images\categoryIcon.png">
-      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
-    </Content>
-    <Content Include="Images\actionIcon%402x.png">
-      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
-    </Content>
-    <Content Include="Images\actionIcon.png">
-      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
-    </Content>
-    <Content Include="Images\icon%402x.png">
-      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
-    </Content>
-    <Content Include="Images\icon.png">
-      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
-    </Content>
-    <Content Include="Images\pluginAction%402x.png">
-      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
-    </Content>
-    <Content Include="Images\pluginAction.png">
-      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
-    </Content>
-    <Content Include="Images\pluginIcon%402x.png">
-      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
-    </Content>
-    <Content Include="Images\pluginIcon.png">
-      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
-    </Content>
-    <Content Include="Images\systemSounds%402x.png">
-      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
-    </Content>
-    <Content Include="Images\systemSounds.png">
+    <Content Include="Images\**\*.png">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </Content>
     <Content Include="PropertyInspector\PluginActionPI.html">
@@ -145,8 +115,4 @@
     </PackageReference>
   </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
-  <PropertyGroup>
-    <PostBuildEvent>
-    </PostBuildEvent>
-  </PropertyGroup>
-</Project>
+</Project>