From 4fe1acab36fa45da80a8108c22b53f9d044e12f8 Mon Sep 17 00:00:00 2001 From: Sanidhya Singh Date: Fri, 23 Dec 2022 22:39:55 +0530 Subject: [PATCH] Fixes Ordered Lists Numbering (#22944) - Previously there was a mixture of `1.` `1.` `1.` ... and `1.` `2.` `3.` ... indexing in the readme doc which is changed to a uniform use of `1.` `1.` `1.` .... - There were errors in numbering at 2 places which get fixed by this. --- doc/devdocs/readme.md | 44 +++++++++++++++++++++---------------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/doc/devdocs/readme.md b/doc/devdocs/readme.md index 1760e8a503..cfc328aeb6 100644 --- a/doc/devdocs/readme.md +++ b/doc/devdocs/readme.md @@ -38,17 +38,17 @@ Once you've discussed your proposed feature/fix/etc. with a team member, and you ### Prerequisites for Compiling PowerToys 1. Windows 10 April 2018 Update (version 1803) or newer -2. Visual Studio Community/Professional/Enterprise 2022 17.4 or newer -3. Git clone PowerToys repository -4. Open started the `PowerToys.sln` -5, If you see a dialog that says `install extra components` in the solution explorer pane, click `install` +1. Visual Studio Community/Professional/Enterprise 2022 17.4 or newer +1. Git clone PowerToys repository +1. Open started the `PowerToys.sln` +1. If you see a dialog that says `install extra components` in the solution explorer pane, click `install` ### Get Submodules to compile We have submodules that need to be initialized before you can compile most parts of PowerToys. This should be a one time step. 1. Open a terminal -2. Navigate to the folder you cloned PowerToys to. -3. Run `git submodule update --init --recursive` +1. Navigate to the folder you cloned PowerToys to. +1. Run `git submodule update --init --recursive` ### Compiling Source Code @@ -65,22 +65,22 @@ Our installer is two parts, an EXE and an MSI. The EXE (Bootstrapper) contains The installer can only be compiled in `Release` mode, step 1 and 2 must be done before the MSI will be able to be compiled. 1. Compile `PowerToys.sln`. Instructions are listed above. -2. Compile `BugReportTool.sln` tool. Path from root: `tools\BugReportTool\BugReportTool.sln` (details listed below) -3. Compile `WebcamReportTool.sln` tool. Path from root: `tools\WebcamReportTool\WebcamReportTool.sln` (details listed below) -3. Compile `StylesReportTool.sln` tool. Path from root: `tools\StylesReportTool\StylesReportTool.sln` (details listed below) -4. Compile `PowerToysSetup.sln` Path from root: `installer\PowerToysSetup.sln` (details listed below) +1. Compile `BugReportTool.sln` tool. Path from root: `tools\BugReportTool\BugReportTool.sln` (details listed below) +1. Compile `WebcamReportTool.sln` tool. Path from root: `tools\WebcamReportTool\WebcamReportTool.sln` (details listed below) +1. Compile `StylesReportTool.sln` tool. Path from root: `tools\StylesReportTool\StylesReportTool.sln` (details listed below) +1. Compile `PowerToysSetup.sln` Path from root: `installer\PowerToysSetup.sln` (details listed below) ### Prerequisites for building the MSI installer 1. Install the [WiX Toolset Visual Studio 2022 Extension](https://marketplace.visualstudio.com/items?itemName=WixToolset.WixToolsetVisualStudio2022Extension). -2. Install the [WiX Toolset build tools](https://wixtoolset.org/releases/v3-14-0-6526/). -3. Download [WiX binaries](https://wixtoolset.org/downloads/v3.14.0.6526/wix314-binaries.zip) and extract `wix.targets` to `C:\Program Files (x86)\WiX Toolset v3.14`. +1. Install the [WiX Toolset build tools](https://wixtoolset.org/releases/v3-14-0-6526/). +1. Download [WiX binaries](https://wixtoolset.org/downloads/v3.14.0.6526/wix314-binaries.zip) and extract `wix.targets` to `C:\Program Files (x86)\WiX Toolset v3.14`. ### Locally building the installer prerequisite projects all at once from the command-line 1. Open a `Developer Command Prompt for VS 2022` -2. Ensure `nuget.exe` is in your `%path%` -3. In the repo root, run these commands: +1. Ensure `nuget.exe` is in your `%path%` +1. In the repo root, run these commands: ``` nuget restore .\tools\BugReportTool\BugReportTool.sln @@ -96,26 +96,26 @@ msbuild -p:Platform=x64 -p:Configuration=Release .\tools\StylesReportTool\Styles ### Locally compiling the Bug reporting tool 1. Open `tools\BugReportTool\BugReportTool.sln` -2. In Visual Studio, in the `Solutions Configuration` drop-down menu select `Release` -3. From the `Build` menu, choose `Build Solution`. +1. In Visual Studio, in the `Solutions Configuration` drop-down menu select `Release` +1. From the `Build` menu, choose `Build Solution`. ### Locally compiling the Webcam reporting tool 1. Open `tools\WebcamReportTool\WebcamReportTool.sln` -2. In Visual Studio, in the `Solutions Configuration` drop-down menu select `Release` -3. From the `Build` menu, choose `Build Solution`. +1. In Visual Studio, in the `Solutions Configuration` drop-down menu select `Release` +1. From the `Build` menu, choose `Build Solution`. ### Locally compiling the Window styles reporting tool 1. Open `tools\StylesReportTool\StylesReportTool.sln` -2. In Visual Studio, in the `Solutions Configuration` drop-down menu select `Release` -3. From the `Build` menu, choose `Build Solution`. +1. In Visual Studio, in the `Solutions Configuration` drop-down menu select `Release` +1. From the `Build` menu, choose `Build Solution`. ### Locally compiling the installer 1. Open `installer\PowerToysSetup.sln` -2. In Visual Studio, in the `Solutions Configuration` drop-down menu select `Release` -3. From the `Build` menu choose `Build Solution`. +1. In Visual Studio, in the `Solutions Configuration` drop-down menu select `Release` +1. From the `Build` menu choose `Build Solution`. The resulting `PowerToysSetup.msi` installer will be available in the `installer\PowerToysSetup\x64\Release\` folder.