Skip to content

Commit 47e5970

Browse files
committed
Documentation update
1 parent eb41ad5 commit 47e5970

File tree

2 files changed

+35
-27
lines changed

2 files changed

+35
-27
lines changed

README.md

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

3-
.NET library enabling Windows multiple desktop operations
3+
.NET library for Windows multiple desktop operations
44

55
[![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)
66
[![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)
@@ -18,13 +18,11 @@
1818

1919
## Features
2020

21-
* Switch, add, and remove a virtual desktop.
22-
* Move the window in the same process to any virtual desktop.
23-
* Move the window of another process to any virtual desktop (Support in version 2.0 or later).
24-
* Pin any window or application; will be display on all desktops.
25-
* Notification for switching, deletion, renaming, etc.
26-
* Change the wallpaper for each desktop.
27-
21+
* Switch, add, and remove a virtual desktop
22+
* Move any window to any virtual desktop
23+
* Pin any window or application for them to show on all desktops
24+
* Notifications when switching, deleting, or renaming virtual desktops
25+
* Change the wallpaper for each desktop
2826

2927
### Sample app
3028

@@ -51,23 +49,20 @@ Install NuGet package(s).
5149
PM> Install-Package VirtualDesktop
5250
```
5351

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).
52+
* [VirtualDesktop] - Core classes for VirtualDesktop.
53+
* [VirtualDesktop.WPF] - Provides extension methods for [WPF Window class].
54+
* [VirtualDesktop.WinForms] - Provides extension methods for [Form class].
5755

5856

5957
## How to use
6058

6159
### Preparation
62-
Because of the dependency on [C#/WinRT](https://aka.ms/cswinrt) ([repo](https://github.com/microsoft/CsWinRT)), the target framework must be set to `net5.0-windows10.0.19041.0` or later.
63-
```xml
64-
<TargetFramework>net5.0-windows10.0.19041.0</TargetFramework>
65-
```
60+
Because of the dependency on [C#/WinRT], the target framework must be set to `net6.0-windows10.0.19041.0` or later.
6661
```xml
6762
<TargetFramework>net6.0-windows10.0.19041.0</TargetFramework>
6863
```
6964

70-
If it doesn't work, try creating an `app.manifest` file and optimize to work on Windows 10.
65+
If it does not work, try creating an `app.manifest` file optimized to work on Windows 10.
7166
```xml
7267
<compatibility xmlns="urn:schemas-microsoft-com:compatibility.v1">
7368
<application>
@@ -135,10 +130,10 @@ window.Pin()
135130

136131
### Windows version support
137132

138-
Since this library is using undocumented interfaces you need to properly [reverse engineer](https://github.com/Slion/VirtualDesktop/issues/14) your Windows version to support it.
133+
Since this library is using undocumented interfaces, you need to [reverse engineer] your Windows version to support it.
139134

140-
The class IDs of some of the undocumented interfaces we use tend to change a lot between different versions of Windows.
141-
If the demo application crashes on start-up chances are all you need to do is provide the proper IDs for the version of Windows you are running on.
135+
The class IDs of undocumented interfaces tend to change between different OS versions.
136+
If the demo application crashes on start-up, you will need to provide the interfaces' IDs matching your Windows version.
142137

143138
Here are the interfaces we need:
144139

@@ -153,14 +148,14 @@ Here are the interfaces we need:
153148
- `IVirtualDesktopNotificationService`
154149
- `IVirtualDesktopPinnedApps`
155150

156-
Once you have the IDs add them in a new `setting` element in [app.config].
157-
Make sure to specify the correct 5 digits Windows build version.
151+
Once you have those IDs, add them in a new `setting` element in [app.config].
152+
Make sure to specify the correct 9 digits Windows build and cumulative update version.
158153
You can get it using one of those methods:
159154
- From the UI run: `winver`
160155
- From shell run: `ver`
161156
- From powershell run: `cmd /c ver`
162157

163-
Make sure to contribute back your changes.
158+
Don't forget to contribute back your changes.
164159

165160
## Publish
166161

@@ -169,7 +164,7 @@ To publish a new release specify your version in [Directory.Build.props] and pus
169164

170165
## Internals
171166

172-
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.
167+
This library is essentially a C# wrapper for [IVirtualDesktopManager] and related undocumented interfaces.
173168
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.
174169

175170
## Resources
@@ -178,16 +173,29 @@ In order to support breaking binary changes between Windows versions we perform
178173
* [Upstream repository](https://github.com/Grabacr07/VirtualDesktop) - unmaintained
179174
* [VirtualDesktop command line tool](https://github.com/MScholtes/VirtualDesktop) - not using this library
180175
* [VirtualDesktop AutoHotKey DLL](https://github.com/Ciantic/VirtualDesktopAccessor)
176+
* [C#/WinRT repository](https://github.com/microsoft/CsWinRT)
181177

182178
## License
183179

184-
This library is under [the MIT License](https://github.com/Grabacr07/VirtualDesktop/blob/master/LICENSE).
180+
This library is under the [MIT License].
185181

186182

187183
[app.config]: src/VirtualDesktop/app.config
188184
[Directory.Build.props]: src/Directory.Build.props
189185

190186
## Credits
191187

192-
* Thanks [@Grabacr07](https://github.com/Grabacr07) for creating this great piece of software
193-
* All contributors for sharing your work with the community
188+
* Thanks [@Grabacr07] for creating this great piece of software
189+
* All contributors for sharing your work with the community
190+
191+
192+
[VirtualDesktop]: https://www.nuget.org/packages/Slions.VirtualDesktop/
193+
[VirtualDesktop.WPF]: https://www.nuget.org/packages/Slions.VirtualDesktop.WPF/
194+
[VirtualDesktop.WinForms]: https://www.nuget.org/packages/Slions.VirtualDesktop.WinForms/
195+
[WPF Window class]: https://msdn.microsoft.com/en-us/library/system.windows.window(v=vs.110).aspx
196+
[Form class]: https://msdn.microsoft.com/en-us/library/system.windows.forms.form(v=vs.110).aspx
197+
[C#/WinRT]: https://aka.ms/cswinrt
198+
[reverse engineer]: https://github.com/Slion/VirtualDesktop/issues/14
199+
[IVirtualDesktopManager]: https://msdn.microsoft.com/en-us/library/windows/desktop/mt186440%28v%3Dvs.85%29.aspx
200+
[MIT License]: https://github.com/Grabacr07/VirtualDesktop/blob/master/LICENSE
201+
[@Grabacr07]: https://github.com/Grabacr07

src/VirtualDesktop/VirtualDesktop.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
<Authors>$(PublishAuthors)</Authors>
1313
<Company>slions.net</Company>
1414
<Copyright>Copyright © 2022 Manato KAMEYA</Copyright>
15-
<Description>.NET library enabling Windows multiple desktop operations</Description>
15+
<Description>.NET library for Windows multiple desktop operations</Description>
1616
<RepositoryUrl>https://github.com/Slion/VirtualDesktop</RepositoryUrl>
1717
<PackageProjectUrl>https://github.com/Slion/VirtualDesktop</PackageProjectUrl>
1818
<PackageLicenseFile>LICENSE</PackageLicenseFile>

0 commit comments

Comments
 (0)