PowerToys/README.md
Deondre Davis f8a22cbdac
Update README.md (#8639)
* Update README.md

* Typo update

* Adjusted PT Community section and changed headers

* Updating to address comments and re-ordering content
2020-12-17 16:11:08 -08:00

8.6 KiB
Raw Blame History

Welcome to the Microsoft PowerToys repo

Downloads & Release notes | Contributing to PowerToys | What's Happening | Roadmap | Known issues

Build status

Architecture Master Stable Installer
x64 Build Status for Master Build Status for Stable Build Status for Installer

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, or any other tools and resources for Windows development environments, be sure to check out our Microsoft Docs!

Current utilities:

Installing and running Microsoft PowerToys

Requirements

  • Windows 10 v1903 (build 18362) or better preferred, Windows 10 v1803 (build 17134) minimum.
  • Have .NET Core 3.1 Desktop Runtime. The installer should handle this but we want to directly make people aware.

Install from the Microsoft PowerToys GitHub releases page. 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. To install PowerToys, run the following command from the command line / 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. 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 for a detailed breakdown.

⚠ State of code ⚠

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.

License Info

Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution.

Known Issues

  • Color Picker at times won't work when PT is running elevated - #5348. We are currently working on a fix now for this.

Processor support

We currently support the matrix below.

x64 x86 ARM
Supported Issue #602 Issue #490

What's Happening

November 2020 Update

Our goals for v0.27 release cycle 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 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.

Highlights from v0.27

General

  • Installer improvements including dark mode
  • Large sums of accessibility issues fixed.
  • Worked on localization effort. If you find issues, please make us aware so we can correct them.

Color Picker

FancyZones

  • Multi-monitor editor experience now drastically improved for discoverability.
  • Zones being forgotten on restart
  • Added in ability to have no layout

Image Resizer

  • Updated interface

PowerToys Run

  • Removed unused dependencies

PowerRename

  • Added Lookbehind support via Boost library

I'd like to directly call out @davidegiacometti, @gordonwatts, @martinchrzan, @niels9001, @p-storm, @TobiasSekan, @Aaron-Junker, @htcfreek and @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 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, we are proactively working on:

  • Stability
  • Accessibility
  • Video conference mute investigation toward a DirectShow filter versus a driver
  • OOBE work

PowerToys Roadmap

Our prioritized 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. 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.

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 for more information.