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

Merged
merged 5 commits into from
Apr 21, 2022
Merged

Update README #2113

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ff182eb
Update README.md
denelon Apr 20, 2022
38bb3ad
Merge pull request #1 from denelon/README
denelon Apr 20, 2022
33fb816
Added telemetry settings
denelon Apr 21, 2022
eaeb990
Merge pull request #2 from denelon/README
denelon Apr 21, 2022
e8f5e38
Update README.md
denelon Apr 21, 2022
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
24 changes: 10 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Welcome to the Windows Package Manager Client (aka winget.exe) repository
# Windows Package Manager Client

This repository contains the source code for the Windows Package Manager Client (aka winget.exe).
This repository contains the source code for the Windows Package Manager Client.

![winget install wingetcreate](.github/images/WingetInstall.gif)

The packages available to the client are in the [Community repo](https://github.com/microsoft/winget-pkgs).
If you are new to the Windows Package Manager, you might want to [Explore the Windows Package Manager tool](https://docs.microsoft.com/learn/modules/explore-windows-package-manager-tool/?WT.mc_id=AZ-MVP-5004737). The packages available to the client are in the [Windows Package Manager Community Repository](https://github.com/microsoft/winget-pkgs).

## Installing The Client

Expand Down Expand Up @@ -53,11 +53,12 @@ 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)

## Windows Package Manager Release Roadmap
The plan for delivering next Windows Package Manager release [is described here](doc/windows-package-manager-release-roadmap.md), and will be updated as the project proceeds.
The plan for delivering next Windows Package Manager releases is described included in our [discussions](https://github.com/microsoft/winget-cli/discussions/2063), and will be updated as the project proceeds.

## 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>```
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 packages:
denelon marked this conversation as resolved.
Show resolved Hide resolved

`winget install <package>`

## Overview

Expand All @@ -67,13 +68,9 @@ This winget-cli repository includes the source code designed to build the client
### Sources
The client is built around the concept of sources; a set of packages effectively. Sources provide the ability to discover and retrieve 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.

### Package Manager Service
The **Package Manager Service** is responsible for approving Pull Requests. It validates the YAML and [manifest spec](/doc/ManifestSpecv1.0.md) for spec compliance.

* The default "winget" source includes packages in the [Windows Package Manager Community Repository](https://github.com/microsoft/winget-pkgs).
* The defualt "msstore" source includes packages in the Microsoft Store.
denelon marked this conversation as resolved.
Show resolved Hide resolved
* It is also possible to host your own private [REST based](https://github.com/microsoft/winget-cli-restsource) source.

## Building the client

Expand All @@ -98,7 +95,6 @@ We currently only build using the solution; command line methods of building a V

We would like to thank [Keivan Beigi (@kayone)](https://github.com/kayone) for his work on AppGet which helped us on the initial project direction for Windows Package Manager.


## Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a
Expand Down