Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #240

Merged
merged 4 commits into from
Oct 19, 2023
+10 −16
Merged

Update README.md #240

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
db3c875
Update README.md
krschau Oct 10, 2023
ef38112
Apply suggestions from code review
krschau Oct 10, 2023
46a84f2
Fix username
krschau Oct 10, 2023
309cc0c
fix spacing because github adds in blank lines for some reason
krschau Oct 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 10 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
![image](https://github.com/microsoft/devhomegithubextension/blob/main/src/GithubPluginServer/Assets/StoreDisplay-150.png)
![image](https://github.com/microsoft/devhomegithubextension/blob/main/src/GitHubExtensionServer/Assets/StoreDisplay-150.png)

# Welcome to the Dev Home GitHub Extension repo


This repository contains the source code for:

* [Dev Home GitHub Extension](https://aka.ms/devhomegithubextension)
Expand All @@ -16,14 +15,12 @@ Related repositories include:

> **Note**: The Dev Home GitHub Extension requires Dev Home. Dev Home requires Windows 11 21H2 (build 22000) or later.

### Microsoft Store [Recommended]

Install [Dev Home from the Microsoft Store](https://aka.ms/devhome) and the Dev Home GitHub Extension will automatically be installed on first launch of Dev Home.
This allows you to always be on the latest version when we release new builds with automatic upgrades.
### Dev Home Extensions library [Recommended]
You can install the Dev Home GitHub Extension from the Extensions library within Dev Home. This page can be found in the left-hand navigation pane. The list of available extensions will provide links to install from the store.

This is our preferred method.
### Microsoft Store

You can also install the Dev Home GitHub Extension from its own [Microsoft Store listing](https://aka.ms/devhomegithubextension).
You can also install the Dev Home GitHub Extension directly from its [Microsoft Store listing](https://aka.ms/devhomegithubextension).

### Other install methods

Expand All @@ -39,11 +36,11 @@ Please take a few minutes to review the overview below before diving into the co

### Widgets

The Dev Home GitHub Extension provides widgets for Dev Home's dashboard, which is built as a Windows widget renderer. These widgets are built using the Windows widget platform, which relies on Adaptive Cards.
The Dev Home GitHub Extension provides widgets for Dev Home's dashboard, which is built as a Windows widget renderer. These widgets are built using the [Windows widget platform](https://learn.microsoft.com/windows/apps/design/widgets/), which relies on [Adaptive Cards](https://learn.microsoft.com/windows/apps/design/widgets/widgets-create-a-template).

### Machine configuration repository recommendations

The machine configuration tool utilizes the Dev Home GitHub Extension to recommend repositories to clone, but isn't required to clone and install apps. The app installation tool is powered by winget.
The machine configuration tool utilizes the Dev Home GitHub Extension to recommend repositories to clone, but isn't required to clone and install apps. The app installation tool is powered by [winget](https://learn.microsoft.com/windows/package-manager/winget).

---

Expand All @@ -67,9 +64,8 @@ Please file new issues, feature requests and suggestions, but **DO search for si

If you would like to ask a question that you feel doesn't warrant an issue (yet), please reach out to us via Twitter:

* Kayla Cinnamon, Product Manager: [@cinnamon_msft](https://twitter.com/cinnamon_msft)
* Clint Rutkas, Senior Product Manager: [@crutkas](https://twitter.com/crutkas)
* Ujjwal Chadha, Developer: [@ujjwalscript](https://twitter.com/ujjwalscript)
* Kayla Cinnamon, Senior Product Manager: [@cinnamon_msft](https://twitter.com/cinnamon_msft)
* Clint Rutkas, Principal Product Manager: [@clintrutkas](https://twitter.com/clintrutkas)

## Developer guidance

Expand All @@ -80,7 +76,7 @@ If you would like to ask a question that you feel doesn't warrant an issue (yet)

* Clone the repository
* Uninstall the Preview version of the Dev Home GitHub Extension (Dev Home has a hard time choosing which extension to use if two versions exist)
* Open the GITServices.sln in Visual Studio 2022 or later, and build from the IDE, or run build.ps1 from a Visual Studio command prompt.
* Open `GitHubExtension.sln` in Visual Studio 2022 or later and build from the IDE, or run `build\scripts\build.ps1` from a Visual Studio command prompt.

### OAuth App
Since secrets cannot be checked in to the repository, developers must create their own test OAuth app for local tests.
Expand All @@ -89,8 +85,6 @@ Follow this link https://docs.github.com/en/developers/apps/building-oauth-apps/

The OAuth App ClientId and ClientSecret can be added as environment variables using the following instructions:

How to set the environment variables:

On an elevated cmd window:
setx GITHUB_CLIENT_ID "Your OAuth App's ClientId" /m
setx GITHUB_CLIENT_SECRET "Your OAuth App's ClientSecret" /m
Expand Down