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 #173

Merged
merged 3 commits into from
May 19, 2020
Merged

Update README.md #173

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6a84be5
Update README.md
KevinLaMS May 18, 2020
4531c1a
Added link to Roadmap
denelon May 19, 2020
c7597b6
Update README.md
KevinLaMS May 19, 2020
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
20 changes: 16 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,21 @@ You can also [build the client yourself](#building-the-client). While the client

[![Build Status](https://dev.azure.com/ms/winget-cli/_apis/build/status/microsoft.winget-cli?branchName=master)](https://dev.azure.com/ms/winget-cli/_build/latest?definitionId=344&branchName=master)

## Overview

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.
## Overview of the Windows Package Manager
The **Windows Package Manager** is a tool designed to help you quickly and easily discover and install those tools that make your PC environment special. By using the **Windows Package Manager**, from one command, you can install your favorite tool:
```winget install <tool>```

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).
For Preview, the goal is to get something usable in your hands as soon as possible. At preview you can **search**, **show**, and **install** packages. Soon we will have **uninstall**, **list** and **update**. These items are available on our [backlog](https://github.com/microsoft/winget-cli/issues), so feel free to upvote the features you want.

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).
## Overview
The Windows Package Manager consists of 3 pieces:
1) the Windows Package Manager client (winget.exe)
2) the repository of manifest files, sources
3) the Package Manager Service that processes the manifest files
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would remove this block, as I don't think it adds anything.


### Client Repository
This winget-cli repository includes the source code designed to build the client. You are encouraged to participate in the development of this client. 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.
Expand All @@ -47,6 +55,10 @@ The default source reflects that data available from the [Community repo](https:

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.

### Package Manager Service
The **Package Manager Service** is responsible for approving Pull Requests. It validates the YAML and [manifest spec](https://github.com/microsoft/winget-cli/docs/spec/YamlSpec.md) for spec compliance.


## Building the client

### Prerequisites
Expand Down