Mirrors/PowerToys
1
0
Fork 0
mirror of https://github.com/microsoft/PowerToys.git synced 2026-04-09 04:37:30 +02:00
Code Issues Packages Projects Releases Wiki Activity

More instructions to build CmdPal (#40644)

Browse Source 
## Summary of the Pull Request

Added more instructions to first time building command palette

## PR Checklist

- [ ] **Closes:** #xxx
- [ ] **Communication:** I've discussed this with core contributors
already. If the work hasn't been agreed, this work might be rejected
- [ ] **Tests:** Added/updated and all pass
- [ ] **Localization:** All end-user-facing strings can be localized
- [X ] **Dev docs:** Added/updated
- [ ] **New binaries:** Added on the required places
- [ ] [JSON for
signing](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ESRPSigning_core.json)
for new binaries
- [ ] [WXS for
installer](https://github.com/microsoft/PowerToys/blob/main/installer/PowerToysSetup/Product.wxs)
for new binaries and localization folder
- [ ] [YML for CI
pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ci/templates/build-powertoys-steps.yml)
for new test projects
- [ ] [YML for signed
pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/release.yml)
- [ ] **Documentation updated:** If checked, please file a pull request
on [our docs
repo](https://github.com/MicrosoftDocs/windows-uwp/tree/docs/hub/powertoys)
and link it here: #xxx

<!-- Provide a more detailed description of the PR, other things fixed,
or any additional comments/features here -->
## Detailed Description of the Pull Request / Additional comments

<!-- Describe how you validated the behavior. Add automated tests
wherever possible, but list manual validation steps taken as well -->
## Validation Steps Performed
This commit is contained in:
Jessica Dene Earley-Cha
2025-07-22 14:55:19 -07:00
committed by GitHub
parent 6623d0a2ee
commit a0fd2d1517
1 changed files with 13 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
src/modules/cmdpal/README.md
View File

@@ -4,7 +4,6 @@ Windows Command Palette ("CmdPal") is the next iteration of PowerToys Run. With
By default, CmdPal is bound to <kbd>Win+Alt+Space</kbd>. By default, CmdPal is bound to <kbd>Win+Alt+Space</kbd>.
## Creating an extension ## Creating an extension
The fastest way to get started is just to run the "Create extension" command in the palette itself. That'll prompt you for a project name and a Display Name, and where you want to place your project. Then just open the `sln` it produces. You should be ready to go 🙂. The fastest way to get started is just to run the "Create extension" command in the palette itself. That'll prompt you for a project name and a Display Name, and where you want to place your project. Then just open the `sln` it produces. You should be ready to go 🙂.
@@ -22,7 +21,15 @@ We've also got samples, so that you can see how the APIs in-action.
## Building CmdPal ## Building CmdPal
The Command Palette is included as a part of PowerToys. To get started building, open up the root `PowerToys.sln`, to get started building. ### Install & Build PowerToys
1. Follow the install and build instructions for [PowerToys](https://github.com/microsoft/PowerToys/tree/main/doc/devdocs#compiling-powertoys)
### Load & Build
1. In Visual Studio, in the Solution Explorer Pane, confirm that all of the files/projects in `src\modules\CommandPalette` and `src\common\CalculatorEngineCommon` do not have `(unloaded)` on the right side
1. If any file has `(unloaded)`, right click on file and select `Reload Project`
1. Now you can right click on one of the project below to `Build` and then `Deploy`:
Projects of interest are: Projects of interest are:
* `Microsoft.CmdPal.UI`: This is the main project for CmdPal. Build and run this to get the CmdPal. * `Microsoft.CmdPal.UI`: This is the main project for CmdPal. Build and run this to get the CmdPal.