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.

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

Add Overview to README #172

Merged
merged 2 commits into from
May 18, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,18 @@ You can also [build the client yourself](#building-the-client). While the client

## Overview

TBD
Our goal with the Windows Package Manager is to make your development process on Windows easier, faster, and more efficient. The goal isn't to be *the* package manager you use, but we do want to have all of the functionality to be a choice. And if you want to use a different package manager, we at least want to be able to provide you with a simple, quick command to bootstrap you into your preferred experience.

## Resources
Although we are calling it a package manager because the term fits semantically, we don't actually manage what one would traditionally call a 'package'. Windows aleady has such a package manager; the MSIX deployment architecture is built around declarative, bundled packages that can cleanly be added and removed. However, there are many programs that have been written for Windows that are not in an MSIX package. We want to be able to manage these for you as well (as best we can).

TBD
For Preview, the goal is to get something usable in your hands as soon as possible. That means that right now we have the infrastructure to support install. From here, we have plenty of backlog features in our [Issues](https://github.com/microsoft/winget-cli/issues). You can upvote the ones you want, add more, or even [get started on one](https://github.com/microsoft/winget-cli/projects/1).

### Sources
The client is built around the concept of sources; a set of packages effectively. Sources provide the ability to discover and retreive the metadata about the packages, so that the client can act on it.

The default source reflects that data available from the [Community repo](https://github.com/microsoft/winget-pkgs).

We plan to better support additional sources, and additional types of sources, in the future. For now, additional sources can be configured, but only one used at a time.

## Building the client

Expand Down
4 changes: 4 additions & 0 deletions azure-pipelines.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ pr:
branches:
include:
- master
paths:
include:
- azure-pipelines.yml
- src/*

pool:
vmImage: 'windows-latest'
Expand Down