mirrors/PersistentWindows
1
0
Fork 0
mirror of https://github.com/kangyu-california/PersistentWindows.git synced 2025-05-11 04:55:39 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

add help file

Browse source
This commit is contained in:
Kang Yu 2020-11-21 23:11:39 -08:00
parent c6d81deb6a
commit f643ea0323
4 changed files with 24 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

21
Help.md Normal file
View file

@ -0,0 +1,21 @@
# Quick help for PW version 5.6
* How to use snapshot feature
```
Capture snapshot 0 : double click PW icon
Restore snapshot 0 : click PW icon
Capture snapshot N : Shift click PW icon N times (N = 1, 2, 3)
Restore snapshot N : Ctrl click PW icon N times
```
* PW command line options
* -splash=0 : No splash window at PW startup
* -notification=1 : Turn on balloon tip and sound notification when restoring windows
* -delay_start <seconds> : Delay PW invoked from auto startup memu by specified seconds
* -redraw_desktop : redraw whole desktop windows after restore
* -fix_zorder=1 : Turn on z-order fix for automatic restore
* -redirect_appdata : Use current dir instead of user appdata dir to store database file, this option allows run second PW instance.
* -check_upgrade=0 : Disable version upgrade check from beginning
```

2
Ninjacrab.PersistentWindows.Solution/Ninjacrab.PersistentWindows.SystrayShell/SystrayForm.Designer.cs generated
View file

@ -132,7 +132,7 @@ namespace Ninjacrab.PersistentWindows.SystrayShell
//
this.aboutToolStripMenuItem.Name = "aboutToolStripMenuItem";
this.aboutToolStripMenuItem.Size = new System.Drawing.Size(135, 22);
this.aboutToolStripMenuItem.Text = "&About";
this.aboutToolStripMenuItem.Text = "&Help";
this.aboutToolStripMenuItem.Click += new System.EventHandler(this.AboutToolStripMenuItemClickHandler);
// pause/resume upgrade notice

2
Ninjacrab.PersistentWindows.Solution/Ninjacrab.PersistentWindows.SystrayShell/SystrayForm.cs
View file

@ -206,7 +206,7 @@ namespace Ninjacrab.PersistentWindows.SystrayShell
if (foundUpgrade)
Process.Start($"{Program.ProjectUrl}/releases/latest");
else
Process.Start(Program.ProjectUrl);
Process.Start(Program.ProjectUrl + "/Help.md");
}
private void ExitToolStripMenuItemClickHandler(object sender, EventArgs e)

3
README.md
View file

@ -32,8 +32,7 @@ this tool and not have to worry about re-arranging when all is back to normal.
- Alternatively for users who prefer to auto start PersistentWindows using startup menu, this can be achieved by creating a shortcut to PersistentWindows.exe in C:\Users\\<your_user_id>\AppData\Roaming\Microsoft\Windows\Start Menu\Programs\Startup. But this method of auto start may not work as expected for slow computers (see issue #34), it is recommended to delay start by specifying -delay_start \<seconds\> on the command line, 30 seconds seems to be a safe bet.
# Use instructions
- Run PersistentWindows.exe as normal user, a splash window will pop up, indicating the program has started successfully. To disable the splash window, run PersistentWindows.exe -splash_off, or specify the command option in the shortcut or .bat wrapper of PersistentWindows.exe
- To turn on balloon tip and sound notification when restoring windows, run PersistentWindows.exe -notification_on
- Run PersistentWindows.exe as normal user, a splash window will pop up, indicating the program has started successfully.
- PersistentWindows minimizes itself as an icon in the systray area on task bar.
- To save current window layout to persistent storage, right click the icon and select "Capture windows to disk"
- To restore saved window layout from persistent storage, or to recover closed windows after reboot, right click the icon and select "Restore windows from disk"