Skip to content

Latest commit

 

History

History
118 lines (65 loc) · 5.76 KB

README.md

File metadata and controls

118 lines (65 loc) · 5.76 KB

dev-home-readme-header

Welcome to the Dev Home repo

This repository contains the source code for:

Related repositories include:

Installing and running Dev Home

Note: Dev Home requires Windows 11 21H2 (build 22000) or later.

Microsoft Store [Recommended]

Install Dev Home from the Microsoft Store. This allows you to always be on the latest version when we release new builds with automatic upgrades.

This is our preferred method.

Other install methods

Via GitHub

For users who are unable to install Dev Home from the Microsoft Store, released builds can be manually downloaded from this repository's Releases page.

Via Windows Package Manager CLI (aka winget)

winget users can download and install the latest Dev Home release by installing the Microsoft.DevHome package:

winget install --id Microsoft.DevHome -e

Dev Home roadmap

The plan for Dev Home will be posted shortly and will be updated as the project proceeds.


Dev Home overview

Please take a few minutes to review the overview below before diving into the code:

Dashboard

The Dev Home dashboard displays Windows widgets. These widgets are built using the Windows widget platform, which relies on Adaptive Cards.

Machine configuration

The machine configuration tool utilizes the Dev Home GitHub Extension, but isn't required to clone and install apps. The app installation tool is powered by winget.

Popular apps

The machine configuration tool provides a list of popular apps when selecting applications to install. This is currently a hard-coded list of applications that have been popular with developers on Windows. Popularity was determined by high levels of installation and usage. As this is a moment in time, we are not accepting submissions for this list. We're looking to improve the experience with Suggested Apps so the list can be optimized for developers.


Documentation

Documentation for Dev Home can be found at https://aka.ms/devhomedocs.


Contributing

We are excited to work alongside you, our amazing community, to build and enhance Dev Home!

BEFORE you start work on a feature/fix, please read & follow our Contributor's Guide to help avoid any wasted or duplicate effort.

Communicating with the team

The easiest way to communicate with the team is via GitHub issues.

Please file new issues, feature requests, and suggestions but DO search for similar open/closed preexisting issues before creating a new issue.

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

Developer guidance

Building the code

  1. Clone the repository
  2. Configure your system, please use the configuration file. This can be applied by either:
    • Dev Home's machine configuration tool
    • WinGet configuration. If you have the experimental feature enabled, run winget configure .configurations/configuration.dsc.yaml from the project root so relative paths resolve correctly

Running & debugging

In Visual Studio, you should be able to build and debug Dev Home by hitting F5. Make sure to select either the "x64" or the "x86" platform and set DevHome as the selected startup project.


Code of conduct

We welcome contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.