Update launcher readme (#3034)

* Added readme and module overview link

* Fixed image link

* Added a known issue per review comment

* Changed images location
This commit is contained in:
Jessica Yuwono 2020-05-14 17:24:17 -07:00 committed by GitHub
parent 93dc96f150
commit 19f4ad0361
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 74 additions and 2 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.4 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.4 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.6 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.5 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 MiB

View file

@ -140,7 +140,7 @@
Style="{StaticResource SettingsGroupTitleStyle}"
Margin="{StaticResource XSmallBottomMargin}"/>
<HyperlinkButton>
<HyperlinkButton NavigateUri="https://github.com/microsoft/PowerToys/tree/master/src/modules/launcher">
<TextBlock x:Uid="Module_overview" />
</HyperlinkButton>

View file

@ -91,6 +91,8 @@ public:
// Create a Settings object.
PowerToysSettings::Settings settings(hinstance, get_name());
settings.set_description(GET_RESOURCE_STRING(IDS_LAUNCHER_SETTINGS_DESC));
settings.set_overview_link(L"https://github.com/microsoft/PowerToys/blob/master/src/modules/launcher/README.md");
return settings.serialize_to_buffer(buffer, buffer_size);
}

View file

@ -1 +1,71 @@
TO DO UPDATE
# PowerToys Run
PowerToys Run is a quick launcher for power users that has additional
capabilities without sacrificing performance. It is open source and
modular for additional plugins. Press Alt+Space and start typing!
![](../../../doc/images/Launcher/QuickStart.gif)
# 1\. Get Started
## 1\.1 Features
Search for applications, folders, or files
![](../../../doc/images/Launcher/Features.gif)
Search for running processes (previously
[WindowWalker](https://github.com/betsegaw/windowwalker/))
![](../../../doc/images/Launcher/FeaturesWindowWalker.gif)
Clickable buttons with keyboard shortcuts
![](../../../doc/images/Launcher/FeaturesButtons.gif)
Invoke Shell Plugin using "\> "
![](../../../doc/images/Launcher/FeaturesShell.gif)
Do a simple calculation using calculator
![](../../../doc/images/Launcher/FeaturesCalculator.gif)
## 1\.2 Settings
| **Settings** | **Action** |
| --------------- | ------------------------------------------------------------------------------- |
| Maximum number of results | Maximum number of results shown without scrolling on PowerToys Run |
| Open PowerToys Run shortcut | The keyboard shortcut to open/hide PowerToys Run |
## 1\.3 Keyboard Shortcuts
| **Shortcuts** | **Action** |
| ------------------ | ---------------------------------------------------------------------------------|
| Alt+Space | Open or hide PowerToys Run |
| Esc | Hide PowerToys Run |
| Ctrl+Shift+Enter | (Only applicable to applications) Open the selected application as administrator |
| Ctrl+Shift+E | (Only applicable to applications and files) Open containing folder in File Explorer |
| Ctrl+C | (Only applicable to folders and files) Copy path location |
| Tab | Navigate through the search result and context menu buttons |
# 2\. Known Issues
- [Shudder on monitor change in a multi-monitor setup](https://github.com/microsoft/PowerToys/issues/3018)
- [On first start, clicking away doesn't hide launcher](https://github.com/microsoft/PowerToys/issues/2973)
- [Navigating through Tab doesn't have a clear UI indication if context buttons or search result is selected](https://github.com/microsoft/PowerToys/issues/2559)
- ['\>' entered at the beginning disappears when you choose an option through keyboard navigation](https://github.com/microsoft/PowerToys/issues/2576)
- [There is a misalignment in the shadow text](https://github.com/microsoft/PowerToys/issues/2494)
- [Reducing number of shown results doesn't resize search result properly](https://github.com/microsoft/PowerToys/issues/2456)
- [Context menu buttons sometimes are not showing when hovered with mouse](https://github.com/microsoft/PowerToys/issues/2420)
- [Scroll on the first result, not the whole search result box](https://github.com/microsoft/PowerToys/issues/2306)
For a list of all known issues/suggestions, check it out
[here](https://github.com/microsoft/PowerToys/issues?q=is%3Aopen+is%3Aissue+label%3AProduct-Launcher).
# 3\. Attribution
[Wox](https://github.com/Wox-launcher/Wox/)
[Beta Tadele's Window Walker](https://github.com/Wox-launcher/Wox/)