Skip to content
Closed
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
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,15 @@ This repository contains the contents formerly at https://github.com/microsoft/v
# Vcpkg-ce: "Configure Environment" / artifacts

Parts of vcpkg powered by "ce" are currently in 'preview' -- there will most certainly be changes between now
and when the tool is 'released' based on feedback.
and when the tool is 'released' based on feedback.

You can use it, but be forewarned that we may change formats, commands, etc.
You can use it, but be forewarned that we may change formats, commands, etc.

Think of it as a manifest-driven desired state configuration for C/C++ projects.
Think of it as a manifest-driven desired state configuration for C/C++ projects.

It
It
- integrates itself into your shell (PowerShell, CMD, bash/zsh)
- can restore artifacts according to a manifest that follows one’s code
- can restore artifacts according to a manifest that follows one’s code
- provides discoverability interfaces

## Installation
Expand All @@ -54,7 +54,7 @@ While the usage of `ce` is the same on all platforms, the installation/loading/r
| `artifact metadata` | A description of the locations one or more artifacts describing rules for which ones are deployed given selection of a host architecture, target architecture, or other properties|
| `artifact identity` | A short string that uniquely describes a moniker that a given artifact (and its metadata) can be referenced by. They can have one of the following forms:<br> `full/identity/path` - the full identity of an artifact that is in the built-in artifact source<br>`sourcename:full/identity/path` - the full identity of an artifact that is in the artifact source specified by the sourcename prefix<br>`shortname` - the shortened unique name of an artifact that is in the built-in artifact source<br>`sourcename:shortname` - the shortened unique name of an artifact that is in the artifact source specified by the sourcename prefix<br>Shortened names are generated based off the shortest unique identity path in the given source. |
| `artifact source` | Also known as a “feed”. An Artifact Source is a location that hosts metadata to locate artifacts. (_There is only one source currently_) |
| `project profile` | The per-project configuration file (`environment.yaml` or `environment.json`)
| `project profile` | The per-project configuration file (`environment.yaml` or `environment.json`)
| `AMF`&nbsp;or&nbsp;`Metadata`&nbsp;`Format` | The schema / format of the YAML/JSON files for project profiles, global settings, and artifacts metadata. |
| `activation` | The process by which a particular set of artifacts are acquired and enabled for use in a calling command program.|
| `versions` | Version numbers are specified using the Semver format. If a version for a particular operation isn't specified, a range for the latest version ( `*` ) is assumed. A version or version range can be specified using the npm semver matching syntax. When a version is stored, it can be stored using the version range specified, a space and then the version found. (ie, the first version is what was asked for, the second is what was installed. No need for a separate lock file.) |
Expand Down Expand Up @@ -82,8 +82,8 @@ contain 3rd party code as documented in `NOTICE.txt`.

# 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
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](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
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.
Expand All @@ -97,4 +97,4 @@ passing --disable-metrics to vcpkg on the command line,
or by setting the VCPKG_DISABLE_METRICS environment variable.

Read more about vcpkg telemetry at [docs/about/privacy.md](https://github.com/microsoft/vcpkg/blob/master/docs/about/privacy.md)
in the main repository
in the main repository