mirror/PowerToys
1
0
Fork 0
mirror of https://github.com/microsoft/PowerToys.git synced 2025-01-23 18:03:54 +08:00
Code Issues Actions 10 Packages Projects Releases Wiki Activity
0b1232b65d
PowerToys/doc/devdocs/readme.md

91 lines
4.3 KiB
Markdown
Raw Normal View History

Docs tweaks (#960) Change header levels Add Github workflow Add reference to coding style Minor tweaks Fix links Add border to images Scale images
2019-12-18 00:02:45 +08:00
# Dev Documentation
Devdocs reorganisation (#913) * docs: split usage and dev docs * # This is a combination of 2 commits. # This is the 1st commit message: docs: split usage and dev docs # The commit message #2 will be skipped: # fixup add docs * docs: add runner documentation and move hooks documentation to devdocs * docs: add stubs for modules technical description * docs: add paragraph about event thread-safety * docs: add 'Current modules' section header
2019-12-12 17:25:19 +08:00
## Rules
Docs tweaks (#960) Change header levels Add Github workflow Add reference to coding style Minor tweaks Fix links Add border to images Scale images
2019-12-18 00:02:45 +08:00
- **Follow the pattern of what you already see in the code.**
- [Coding style](style.md).
- Try to package new ideas/components into libraries that have nicely defined interfaces.
- Package new ideas into classes or refactor existing ideas into a class as you extend.
- Whean adding new classes/methos/changing existing code: add new unit tests or update the existing tests.
Devdocs reorganisation (#913) * docs: split usage and dev docs * # This is a combination of 2 commits. # This is the 1st commit message: docs: split usage and dev docs # The commit message #2 will be skipped: # fixup add docs * docs: add runner documentation and move hooks documentation to devdocs * docs: add stubs for modules technical description * docs: add paragraph about event thread-safety * docs: add 'Current modules' section header
2019-12-12 17:25:19 +08:00
Docs tweaks (#960) Change header levels Add Github workflow Add reference to coding style Minor tweaks Fix links Add border to images Scale images
2019-12-18 00:02:45 +08:00
## Github Workflow
- Follow the PR template, in particular make sure there is open issue for the new PR.
- When the PR is approved, let the owner of the PR merge it.
- Use the `Squash and merge` option to merge a PR, if you don't want to squash it because there are logically different commits, use `Rebase and merge`.
- We don't close issues automatically when referenced in a PR, so after the OR is merged:
- mark the issue(s) fixed by the PR with the `resolved` label.
- don't close the issue if it's a bug in the current release since users tend to not search for closed issues, we will close the resolved issues when a new released is published.
## Repository Overview
Devdocs reorganisation (#913) * docs: split usage and dev docs * # This is a combination of 2 commits. # This is the 1st commit message: docs: split usage and dev docs # The commit message #2 will be skipped: # fixup add docs * docs: add runner documentation and move hooks documentation to devdocs * docs: add stubs for modules technical description * docs: add paragraph about event thread-safety * docs: add 'Current modules' section header
2019-12-12 17:25:19 +08:00
General project organization:
#### The [`doc`](/doc) folder
Docs tweaks (#960) Change header levels Add Github workflow Add reference to coding style Minor tweaks Fix links Add border to images Scale images
2019-12-18 00:02:45 +08:00
Documentation for the project.
Devdocs reorganisation (#913) * docs: split usage and dev docs * # This is a combination of 2 commits. # This is the 1st commit message: docs: split usage and dev docs # The commit message #2 will be skipped: # fixup add docs * docs: add runner documentation and move hooks documentation to devdocs * docs: add stubs for modules technical description * docs: add paragraph about event thread-safety * docs: add 'Current modules' section header
2019-12-12 17:25:19 +08:00
#### The [`installer`](/installer) folder
Contains the source code of the PowerToys installer.
#### The [`src`](/src) folder
Contains the source code of the PowerToys runner and of all of the PowerToys modules. **This is where the most of the magic happens.**
#### The [`tools`](/tools) folder
Various tools used by PowerToys. Includes the Visual Studio 2019 project template for new PowerToys.
# Implementation details
Docs tweaks (#960) Change header levels Add Github workflow Add reference to coding style Minor tweaks Fix links Add border to images Scale images
2019-12-18 00:02:45 +08:00
### [`Runner`](runner.md)
Devdocs reorganisation (#913) * docs: split usage and dev docs * # This is a combination of 2 commits. # This is the 1st commit message: docs: split usage and dev docs # The commit message #2 will be skipped: # fixup add docs * docs: add runner documentation and move hooks documentation to devdocs * docs: add stubs for modules technical description * docs: add paragraph about event thread-safety * docs: add 'Current modules' section header
2019-12-12 17:25:19 +08:00
The PowerToys Runner contains the project for the PowerToys.exe executable.
It's responsible for:
- Loading the individual PowerToys modules.
- Passing registered events to the PowerToys.
- Showing a system tray icon to manage the PowerToys.
- Bridging between the PowerToys modules and the Settings editor.
![Image of the tray icon](/doc/images/runner/tray.png)
Docs tweaks (#960) Change header levels Add Github workflow Add reference to coding style Minor tweaks Fix links Add border to images Scale images
2019-12-18 00:02:45 +08:00
### [`Interface`](modules/interface.md)
Devdocs reorganisation (#913) * docs: split usage and dev docs * # This is a combination of 2 commits. # This is the 1st commit message: docs: split usage and dev docs # The commit message #2 will be skipped: # fixup add docs * docs: add runner documentation and move hooks documentation to devdocs * docs: add stubs for modules technical description * docs: add paragraph about event thread-safety * docs: add 'Current modules' section header
2019-12-12 17:25:19 +08:00
Definition of the interface used by the [`runner`](/src/runner) to manage the PowerToys. All PowerToys must implement this interface.
Docs tweaks (#960) Change header levels Add Github workflow Add reference to coding style Minor tweaks Fix links Add border to images Scale images
2019-12-18 00:02:45 +08:00
### [`Common`](common.md)
Devdocs reorganisation (#913) * docs: split usage and dev docs * # This is a combination of 2 commits. # This is the 1st commit message: docs: split usage and dev docs # The commit message #2 will be skipped: # fixup add docs * docs: add runner documentation and move hooks documentation to devdocs * docs: add stubs for modules technical description * docs: add paragraph about event thread-safety * docs: add 'Current modules' section header
2019-12-12 17:25:19 +08:00
The common lib, as the name suggests, contains code shared by multiple PowerToys components and modules, e.g. [json parsing](/src/common/json.h) and [IPC primitives](/src/common/two_way_pipe_message_ipc.h).
Docs tweaks (#960) Change header levels Add Github workflow Add reference to coding style Minor tweaks Fix links Add border to images Scale images
2019-12-18 00:02:45 +08:00
### [`Settings`](settings.md)
Devdocs reorganisation (#913) * docs: split usage and dev docs * # This is a combination of 2 commits. # This is the 1st commit message: docs: split usage and dev docs # The commit message #2 will be skipped: # fixup add docs * docs: add runner documentation and move hooks documentation to devdocs * docs: add stubs for modules technical description * docs: add paragraph about event thread-safety * docs: add 'Current modules' section header
2019-12-12 17:25:19 +08:00
WebView project for editing the PowerToys settings.
The html portion of the project that is shown in the WebView is contained in [`settings-html`](/src/settings/settings-heml).
Instructions on how build a new version and update this project are in the [Web project for the Settings UI](./settings-web.md).
While developing, it's possible to connect the WebView to the development server running in localhost by setting the `_DEBUG_WITH_LOCALHOST` flag to `1` and following the instructions near it in `./main.cpp`.
Docs tweaks (#960) Change header levels Add Github workflow Add reference to coding style Minor tweaks Fix links Add border to images Scale images
2019-12-18 00:02:45 +08:00
### [`Settings-web`](settings-web.md)
Devdocs reorganisation (#913) * docs: split usage and dev docs * # This is a combination of 2 commits. # This is the 1st commit message: docs: split usage and dev docs # The commit message #2 will be skipped: # fixup add docs * docs: add runner documentation and move hooks documentation to devdocs * docs: add stubs for modules technical description * docs: add paragraph about event thread-safety * docs: add 'Current modules' section header
2019-12-12 17:25:19 +08:00
This project generates the web UI shown in the [PowerToys Settings](/src/editor).
It's a `ReactJS` project created using [UI Fabric](https://developer.microsoft.com/en-us/fabric#/).
## Current modules
Docs tweaks (#960) Change header levels Add Github workflow Add reference to coding style Minor tweaks Fix links Add border to images Scale images
2019-12-18 00:02:45 +08:00
### [`FancyZones`](modules/fancyzones.md)
Devdocs reorganisation (#913) * docs: split usage and dev docs * # This is a combination of 2 commits. # This is the 1st commit message: docs: split usage and dev docs # The commit message #2 will be skipped: # fixup add docs * docs: add runner documentation and move hooks documentation to devdocs * docs: add stubs for modules technical description * docs: add paragraph about event thread-safety * docs: add 'Current modules' section header
2019-12-12 17:25:19 +08:00
The FancyZones PowerToy that allows users to create custom zones on the screen, to which the windows will snap when moved.
Docs tweaks (#960) Change header levels Add Github workflow Add reference to coding style Minor tweaks Fix links Add border to images Scale images
2019-12-18 00:02:45 +08:00
### [`PowerRename`](modules/powerrename.md)
Devdocs reorganisation (#913) * docs: split usage and dev docs * # This is a combination of 2 commits. # This is the 1st commit message: docs: split usage and dev docs # The commit message #2 will be skipped: # fixup add docs * docs: add runner documentation and move hooks documentation to devdocs * docs: add stubs for modules technical description * docs: add paragraph about event thread-safety * docs: add 'Current modules' section header
2019-12-12 17:25:19 +08:00
PowerRename is a Windows Shell Context Menu Extension for advanced bulk renaming using simple search and replace or more powerful regular expression matching.
Docs tweaks (#960) Change header levels Add Github workflow Add reference to coding style Minor tweaks Fix links Add border to images Scale images
2019-12-18 00:02:45 +08:00
### [`Shortcut Guide`](modules/shortcut_guide.md)
Devdocs reorganisation (#913) * docs: split usage and dev docs * # This is a combination of 2 commits. # This is the 1st commit message: docs: split usage and dev docs # The commit message #2 will be skipped: # fixup add docs * docs: add runner documentation and move hooks documentation to devdocs * docs: add stubs for modules technical description * docs: add paragraph about event thread-safety * docs: add 'Current modules' section header
2019-12-12 17:25:19 +08:00
The Windows Shortcut Guide, displayed when the WinKey is held for some time.
Docs tweaks (#960) Change header levels Add Github workflow Add reference to coding style Minor tweaks Fix links Add border to images Scale images
2019-12-18 00:02:45 +08:00
### _obsolete_ [`example_powertoy`](modules/example_powertoy.md)
Devdocs reorganisation (#913) * docs: split usage and dev docs * # This is a combination of 2 commits. # This is the 1st commit message: docs: split usage and dev docs # The commit message #2 will be skipped: # fixup add docs * docs: add runner documentation and move hooks documentation to devdocs * docs: add stubs for modules technical description * docs: add paragraph about event thread-safety * docs: add 'Current modules' section header
2019-12-12 17:25:19 +08:00
An example PowerToy, that demonstrates how to create new ones. Please note, that this is going to become a Visual Studio project template soon.
This PowerToy serves as a sample to show how to implement the [PowerToys interface](/src/modules/interface/) when creating a PowerToy. It also showcases the currently implemented settings.
#### Options
This module has a setting to serve as an example for each of the currently implemented settings property:
- BoolToggle property
- IntSpinner property
- String property
- ColorPicker property
- CustomAction property
![Image of the Options](/doc/images/example_powertoy/settings.png)
Reference in New Issue Copy Permalink