Skip to content

Commit 40cc4f3

Browse files
Merge pull request microsoft#2 from microsoft/updateREADME
Update readme
2 parents 174789e + eb535ac commit 40cc4f3

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,29 @@
1+
# Important Instructions \<To be removed before moving to PowerToys Repo>
2+
3+
## Steps to build and run launcher successfully
4+
1. Restore the nuget packages
5+
2. Download and install [Windows 10 SDK version 10.0.14393.795](https://go.microsoft.com/fwlink/p/?LinkId=838916). This SDK cannot be installed using the Visual Studio installer.
6+
3. Build and run PowerToys.sln in Debug/Release mode and x64 configuration.
7+
8+
## Contribution details
9+
10+
### To pull code from PowerToys repository
11+
12+
```powershell
13+
cd Launcher
14+
git remote add public https://github.com/microsoft/PowerToys.git
15+
git pull public master
16+
git push origin <branchname>
17+
```
18+
19+
### To pull code from Wox repository
20+
21+
```powerhsell
22+
Git subtree pull --prefix src/modules/launcher https://github.com/jjw24/Wox.git master
23+
```
24+
25+
**NOTE:** Do not use the `--squash` option while pulling changes from the subtree as that would result in all the changes being reflected as made by you, which would tamper the git history.
26+
127
# Overview
228

329
<img align="right" width="200" src="./doc/images/Logo.jpg" />

0 commit comments

Comments
 (0)