Skip to content

Commit 27752f9

Browse files
committed
Update readme and choco package description
1 parent 2d58aac commit 27752f9

File tree

2 files changed

+34
-20
lines changed

2 files changed

+34
-20
lines changed

README.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,25 @@ You can also give these rules memorable names, and apply any and/or all of them
1111

1212
### Chocolatey
1313

14-
As of v0.10.0, we now have a [Chocolatey package](https://community.chocolatey.org/packages/restorewindowpos/) available. You can install it with:
14+
The [RestoreWindowPos Chocolatey package](https://community.chocolatey.org/packages/restorewindowpos/) can be installed with this command:
1515
```
1616
choco install restorewindowpos
1717
```
18-
If you want to immediately start the program after install:
18+
19+
Chocolatey packages are auto-generated each release using [GitHub actions](https://github.com/Crozzers/RestoreWindowPos/actions). The packages are then submitted to Chocolatey for review and to be published. This process does take time, so the Chocolatey version of the package may lag behind the latest GitHub release.
20+
21+
#### Package Parameters
22+
23+
| Parameter | Descrption |
24+
|----------------------|---------------------------------------------------|
25+
| `/StartAfterInstall` | Launch the program after installation is finished |
26+
| `/DesktopShortcut` | Create a desktop shortcut for the program |
27+
| `/StartMenuShortcut` | Create a start menu shortcut for the program |
28+
29+
Example:
1930
```
20-
choco install restorewindowpos --params '"/StartAfterInstall"'
31+
choco install restorewindowpos --params '"/StartAfterInstall /DesktopShortcut /StartMenuShortcut"'
2132
```
22-
Chocolatey packages are generated upon a new release using [GitHub actions](https://github.com/Crozzers/RestoreWindowPos/actions). The packages are then submitted to Chocolatey for review and to be published. This process does take time, so the Chocolatey version of the package may lag behind the latest GitHub release.
2333

2434
### Manual install
2535

@@ -56,17 +66,11 @@ Check the [contribution guidelines](CONTRIBUTING.md) for instructions on how con
5666

5767
## Features
5868

59-
* Snapshots taken every minute (with options for various different intervals)
69+
* Regular snapshots of current window layout (with options for various different intervals)
6070
* Remembers window sizes and positions and restores them when monitors are connected/disconnected
6171
* Can restore snapped windows
62-
* Can restore past snapshots (remembers up to 10 unique layouts)
72+
* Can restore past snapshots
6373
* Easy to use installer that registers the program as a startup task
64-
* Can pause and resume taking snapshots
6574
* Create and apply rules for specific windows
6675
* Create and apply rules for specific display configurations
67-
68-
## TODO
69-
70-
* Test on Windows 11
71-
* Create wiki with usage instructions
72-
* Add behaviour methods to dataclasses. EG: `Rule` should have method `Rule.apply` to apply the rule
76+
* React to new windows spawning and take some predefined action

tools/choco_template/restorewindowpos.nuspec

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,27 @@
1818
<packageSourceUrl>https://github.com/Crozzers/RestoreWindowPos/tree/main/tools/choco_template</packageSourceUrl>
1919
<tags>restorewindowpos system-tweak window-management</tags>
2020
<description>
21-
Whenever I connect/disconnect a monitor, all of my windows jump around, resize and teleport to places they are not meant to be in.
21+
Whenever I connect/disconnect a monitor, all of my windows jump around, resize and teleport to places they are not meant to be in.
2222

23-
This project aims to fix this behaviour by taking regular snapshots of window positions. Once it detects a display being connected/disconnected, it will restore windows to their last known positions on that display.
23+
This project aims to fix this behaviour by taking regular snapshots of window positions. Once it detects a display being connected/disconnected, it will restore windows to their last known positions on that display.
2424

25-
You can also define rules for windows with specific titles and/or created by specific programs. Rules will be automatically applied to matching windows that are not part of your current snapshot (eg: windows that have been created since a snapshot was last taken). You can also give these rules memorable names, and apply any and/or all of them at any time
25+
You can also define rules for windows with specific titles and/or created by specific programs. Rules will be automatically applied to matching windows that are not part of your current snapshot (eg: windows that have been created since a snapshot was last taken).
26+
You can also give these rules memorable names, and apply any and/or all of them at any time
2627

27-
## Package Parameters
28+
Chocolatey packages are auto-generated each release using [GitHub actions](https://github.com/Crozzers/RestoreWindowPos/actions). The packages are then submitted to Chocolatey for review and to be published. This process does take time, so the Chocolatey version of the package may lag behind the latest GitHub release.
2829

29-
You can supply a parameter to this package to have it run RestoreWindowPos immediately after it has
30-
been installed/upgraded. For example:
31-
`choco install restorewindowpos --params '"/StartAfterInstall"'`
30+
#### Package Parameters
31+
32+
| Parameter | Descrption |
33+
|----------------------|---------------------------------------------------|
34+
| `/StartAfterInstall` | Launch the program after installation is finished |
35+
| `/DesktopShortcut` | Create a desktop shortcut for the program |
36+
| `/StartMenuShortcut` | Create a start menu shortcut for the program |
37+
38+
Example:
39+
```
40+
choco install restorewindowpos --params '"/StartAfterInstall /DesktopShortcut /StartMenuShortcut"'
41+
```
3242
</description>
3343
<releaseNotes>https://github.com/Crozzers/RestoreWindowPos/releases</releaseNotes>
3444
</metadata>

0 commit comments

Comments
 (0)