PowerToys/README.md

146 lines
8.6 KiB
Markdown
Raw Normal View History

# Welcome to the Microsoft PowerToys repo
<img src="./doc/images/overview/PT%20hero%20image.png"/>
[Downloads & Release notes][github-release-link] | [Contributing to PowerToys](#contributing) | [What's Happening](#whats-happening) | [Roadmap](#powertoys-roadmap) | [Known issues](#known-issues)
## Build status
2020-10-28 07:32:47 +08:00
| Architecture | Master | Stable | Installer |
|--------------|--------|--------|-----------|
| x64 | [![Build Status for Master](https://dev.azure.com/ms/PowerToys/_apis/build/status/microsoft.PowerToys?branchName=master)](https://dev.azure.com/ms/PowerToys/_build/latest?definitionId=219&branchName=master) | [![Build Status for Stable](https://dev.azure.com/ms/PowerToys/_apis/build/status/microsoft.PowerToys?branchName=stable)](https://dev.azure.com/ms/PowerToys/_build/latest?definitionId=219&branchName=stable) | [![Build Status for Installer](https://github-private.visualstudio.com/microsoft/_apis/build/status/CDPX/powertoys/powertoys-Windows-Official-master-Test?branchName=master)](https://github-private.visualstudio.com/microsoft/_build/latest?definitionId=61&branchName=master) |
## About
Microsoft PowerToys is a set of utilities for power users to tune and streamline their Windows 10 experience for greater productivity. For more info on [PowerToys guides and overviews](https://docs.microsoft.com/en-us/windows/powertoys/), or any other tools and resources for [Windows development environments](https://docs.microsoft.com/en-us/windows/dev-environment/overview), be sure to check out our [Microsoft Docs](https://docs.microsoft.com/en-us/)!
Current utilities:
- **[Color Picker](https://aka.ms/PowerToysOverview_ColorPicker)**
- **[FancyZones](https://aka.ms/PowerToysOverview_FancyZones)**
- **[File Explorer Add-ons](https://aka.ms/PowerToysOverview_FileExplorerAddOns)**
- **[Image Resizer](https://aka.ms/PowerToysOverview_ImageResizer)**
- **[Keyboard Manager](https://aka.ms/PowerToysOverview_KeyboardManager)**
- **[PowerRename](https://aka.ms/PowerToysOverview_PowerRename)**
- **[PowerToys Run](https://aka.ms/PowerToysOverview_PowerToysRun)**
- **[Shortcut Guide](https://aka.ms/PowerToysOverview_ShortcutGuide)**
- **[Video Conference Mute (Experimental)](https://aka.ms/PowerToysOverview_VideoConference)**
## Installing and running Microsoft PowerToys
### Requirements
2020-10-29 11:49:02 +08:00
2020-12-02 07:13:27 +08:00
- Windows 10 v1903 (build 18362) or better preferred, Windows 10 v1803 (build 17134) minimum.
- Have [.NET Core 3.1 Desktop Runtime](https://dotnet.microsoft.com/download/dotnet-core/thank-you/runtime-desktop-3.1.10-windows-x64-installer). The installer should handle this but we want to directly make people aware.
### Via GitHub with EXE [Recommended]
2020-12-10 02:33:08 +08:00
Install from the [Microsoft PowerToys GitHub releases page][github-release-link]. Click on `Assets` to show the files available in the release and then click on `PowerToysSetup-0.27.1-x64.exe` to download the PowerToys installer.
This is our preferred method.
### Via WinGet (Preview)
Download PowerToys from [WinGet](https://github.com/microsoft/winget-cli/releases). To install PowerToys, run the following command from the command line / PowerShell:
```powershell
WinGet install powertoys
```
## Contributing
This project welcomes contributions of all types. Help spec'ing, design, documentation, finding bugs are ways everyone can help on top of coding features / bug fixes. We are excited to work with the power user community to build a set of tools for helping you get the most out of Windows.
We ask that **before you start work on a feature that you would like to contribute**, please read our [Contributor's Guide](CONTRIBUTING.md). We will be happy to work with you to figure out the best approach, provide guidance and mentorship throughout feature development, and help avoid any wasted or duplicate effort.
For guidance on developing for PowerToys, please read the [developer docs](/doc/devdocs) for a detailed breakdown.
### ⚠ State of code ⚠
2020-10-14 02:49:52 +08:00
PowerToys is still a very fluidic project and the team is actively working out of this repository. We will be periodically re-structuring/refactoring the code to make it easier to comprehend, navigate, build, test, and contribute to, so **DO expect significant changes to code layout on a regular basis**.
2020-10-29 11:49:02 +08:00
### License Info
Most contributions require you to agree to a [Contributor License Agreement (CLA)][oss-CLA] declaring that you have the right to, and actually do, grant us the rights to use your contribution.
## Known Issues
2020-05-28 00:52:08 +08:00
- Color Picker at times won't work when PT is running elevated - [#5348](https://github.com/microsoft/PowerToys/issues/5348). We are currently working on a fix now for this.
2020-05-28 00:52:08 +08:00
### Processor support
2020-04-01 01:54:45 +08:00
We currently support the matrix below.
| x64 | x86 | ARM |
|:---:|:---:|:---:|
| [Supported][github-release-link] | [Issue #602](https://github.com/microsoft/PowerToys/issues/602) | [Issue #490](https://github.com/microsoft/PowerToys/issues/490) |
## What's Happening
2020-12-01 07:14:08 +08:00
### November 2020 Update
Our goals for [v0.27 release cycle][github-release-link] were to focus on adding on end-user experience, stability, accessibility, localization and quality of life improvements for both the development team and our end users. Our [prioritized roadmap][roadmap] of features and utilities that the core team is focusing on for the near future. We fixed a lot of localization issues from our initial release but we may not still be perfect. If you find an issue, please file a [localization bug][loc-bug].
#### Highlights from v0.27
**General**
2020-12-01 07:38:34 +08:00
- Installer improvements including dark mode
2020-10-28 05:05:05 +08:00
- Large sums of accessibility issues fixed.
2020-12-01 07:38:34 +08:00
- Worked on localization effort. If you find issues, please [make us aware so we can correct them][loc-bug].
2020-10-28 05:05:05 +08:00
**Color Picker**
2020-12-02 01:20:47 +08:00
- Updated interface and new editor experience done by [@martinchrzan](https://github.com/martinchrzan) and [@niels9001](https://github.com/niels9001)
**FancyZones**
2020-12-01 07:14:08 +08:00
- Multi-monitor editor experience now drastically improved for discoverability.
- Zones being forgotten on restart
- Added in ability to have no layout
2020-12-01 07:14:08 +08:00
**Image Resizer**
- Updated interface
2020-10-28 05:05:05 +08:00
**PowerToys Run**
2020-12-01 07:14:08 +08:00
- Removed unused dependencies
**PowerRename**
- Added Lookbehind support via Boost library
2020-10-28 05:05:05 +08:00
2020-12-02 01:20:47 +08:00
I'd like to directly call out [@davidegiacometti](https://github.com/davidegiacometti), [@gordonwatts](https://github.com/gordonwatts), [@martinchrzan](https://github.com/martinchrzan), [@niels9001](https://github.com/niels9001), [@p-storm](https://github.com/p-storm), [@TobiasSekan](https://github.com/TobiasSekan), [@Aaron-Junker](https://github.com/Aaron-Junker), [@htcfreek](https://github.com/htcfreek) and [@alannt777](https://github.com/alannt777) for their continued community support and helping directly make PowerToys a better piece of software.
#### Experimental PowerToys utility with Video conference muting
Install the [v0.28 pre-release experimental version of PowerToys][github-prerelease-link] to try out this version. It includes all improvements from v0.27 in addition to the Video conference utility. Click on `Assets` to show the files available in the release and then download the .exe installer.
#### What is being planned for v0.29 - December 2020
For [v0.29](https://github.com/microsoft/PowerToys/issues?q=is%3Aopen+is%3Aissue+project%3Amicrosoft%2FPowerToys%2F15), we are proactively working on:
- Stability
2020-10-28 05:05:05 +08:00
- Accessibility
2020-12-02 01:23:59 +08:00
- Video conference mute investigation toward a DirectShow filter versus a driver
- OOBE work
## PowerToys Roadmap
2020-10-27 20:27:30 +08:00
Our [prioritized roadmap][roadmap] of features and utilities that the core team is focusing on.
## PowerToys Community
The PowerToys team is extremely grateful to have the [support of an amazing active community](COMMUNITY.md). The work you do is incredibly important. PowerToys wouldnt be nearly what it is today without your help filing bugs, updating documentation, guiding the design, or writing features. We want to say thank you and take time to recognize your work.
## Code of Conduct
This project has adopted the [Microsoft Open Source Code of Conduct][oss-conduct-code].
## Privacy Statement
The application logs basic telemetry. Our Telemetry Data page (Coming Soon) has the trends from the telemetry. Please read the [Microsoft privacy statement][privacyLink] for more information.
2020-02-13 06:55:39 +08:00
[oss-CLA]: https://cla.opensource.microsoft.com
2020-03-13 04:48:38 +08:00
[oss-conduct-code]: CODE_OF_CONDUCT.md
[github-release-link]: https://github.com/microsoft/PowerToys/releases/
2020-12-05 00:20:15 +08:00
[github-prerelease-link]: https://github.com/microsoft/PowerToys/releases/tag/v0.28.0
[roadmap]: https://github.com/microsoft/PowerToys/wiki/Roadmap
[privacyLink]: http://go.microsoft.com/fwlink/?LinkId=521839
[vidConfOverview]: https://aka.ms/PowerToysOverview_VideoConference
2020-10-29 11:49:02 +08:00
[loc-bug]: https://github.com/microsoft/PowerToys/issues/new?assignees=&labels=&template=translation_issue.md&title=