Skip to content

Commit 5b726a8

Browse files
committed
Documentation improvements
1 parent 5ed24d6 commit 5b726a8

File tree

1 file changed

+25
-10
lines changed

1 file changed

+25
-10
lines changed

README.md

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# VirtualDesktop
22

3-
VirtualDesktop is C# wrapper for [IVirtualDesktopManager](https://msdn.microsoft.com/en-us/library/windows/desktop/mt186440%28v%3Dvs.85%29.aspx) on Windows 11 (and Windows 10).
3+
.NET library enabling Windows multiple desktop operations
4+
5+
[![Windows 11](https://img.shields.io/badge/Windows_11-supported-dodgerblue)](https://www.microsoft.com/en-us/windows/learning-center/stay-organized-using-multiple-desktops-windows-11) <br>
6+
[![Windows 10](https://img.shields.io/badge/Windows_10-supported-dodgerblue)](https://support.microsoft.com/en-us/windows/configure-multiple-desktops-in-windows-36f52e38-5b4a-557b-2ff9-e1a60c976434)
47

58
[![Build](https://github.com/Slion/VirtualDesktop/workflows/Build/badge.svg)](https://github.com/Slion/VirtualDesktop/actions/workflows/build.yml)
69
[![Publish](https://github.com/Slion/VirtualDesktop/workflows/Publish/badge.svg)](https://github.com/Slion/VirtualDesktop/actions/workflows/publish.yml)
@@ -32,9 +35,11 @@ VirtualDesktop is C# wrapper for [IVirtualDesktopManager](https://msdn.microsoft
3235
## Requirements
3336

3437
```xml
35-
<TargetFramework>net5.0-windows10.0.19041.0</TargetFramework>
38+
<TargetFramework>net6.0-windows10.0.19041.0</TargetFramework>
3639
```
37-
* .NET 5, 6 or 7
40+
* .NET 6.0
41+
* .NET 7.0
42+
* .NET 8.0
3843
* Windows 10 build 19041 (20H1) or later
3944

4045

@@ -46,9 +51,9 @@ Install NuGet package(s).
4651
PM> Install-Package VirtualDesktop
4752
```
4853

49-
* [VirtualDesktop](https://www.nuget.org/packages/VirtualDesktop/) - Core classes for VirtualDesktop.
50-
* [VirtualDesktop.WPF](https://www.nuget.org/packages/VirtualDesktop.WPF/) - Provides extension methods for WPF [Window class](https://msdn.microsoft.com/en-us/library/system.windows.window(v=vs.110).aspx).
51-
* [VirtualDesktop.WinForms](https://www.nuget.org/packages/VirtualDesktop.WinForms/) - Provides extension methods for [Form class](https://msdn.microsoft.com/en-us/library/system.windows.forms.form(v=vs.110).aspx).
54+
* [VirtualDesktop](https://www.nuget.org/packages/Slions.VirtualDesktop/) - Core classes for VirtualDesktop.
55+
* [VirtualDesktop.WPF](https://www.nuget.org/packages/Slions.VirtualDesktop.WPF/) - Provides extension methods for WPF [Window class](https://msdn.microsoft.com/en-us/library/system.windows.window(v=vs.110).aspx).
56+
* [VirtualDesktop.WinForms](https://www.nuget.org/packages/Slions.VirtualDesktop.WinForms/) - Provides extension methods for [Form class](https://msdn.microsoft.com/en-us/library/system.windows.forms.form(v=vs.110).aspx).
5257

5358

5459
## How to use
@@ -156,20 +161,30 @@ You can get it using one of those methods:
156161

157162
Make sure to contribute back your changes.
158163

159-
### Publish
164+
## Publish
160165

161166
To publish a new release specify your version in [Directory.Build.props] and push the changes with a commit description such as:
162167
`Release vx.y.z` where `x`, `y`, `z` form your version number. That should publish it on NuGet providing that your secret `NUGET_API_KEY` is still valid.
163168

164-
### Resources
169+
## Internals
170+
171+
Essentially a C# wrapper for [IVirtualDesktopManager](https://msdn.microsoft.com/en-us/library/windows/desktop/mt186440%28v%3Dvs.85%29.aspx) and related undocumented interfaces.
172+
However in order to support breaking binary changes between Windows versions we perform runtime compilation of a DLL providing access to the COM interfaces matching your OS build version.
173+
174+
## Resources
165175
* [samples/README.md](samples/README.md)
166176
* [StackOverflow](https://stackoverflow.com/questions/32416843/programmatic-control-of-virtual-desktops-in-windows-10)
167-
177+
* [Upstream repository](https://github.com/Grabacr07/VirtualDesktop) - unmaintained
168178

169179
## License
170180

171181
This library is under [the MIT License](https://github.com/Grabacr07/VirtualDesktop/blob/master/LICENSE).
172182

173183

174184
[app.config]: src/VirtualDesktop/app.config
175-
[Directory.Build.props]: src/Directory.Build.props
185+
[Directory.Build.props]: src/Directory.Build.props
186+
187+
## Credits
188+
189+
* Thanks @Grabacr07 for creating this great piece of software
190+
* All contributors for sharing your work with the community

0 commit comments

Comments
 (0)