Add vcpkg-tool repository README #396
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,117 @@ | ||||||
| --- | ||||||
| title: Microsoft/vcpkg README | ||||||
| description: README for vcpkg-tool repository | ||||||
| author: vicroms | ||||||
| ms.author: viromer | ||||||
| ms.date: 8/28/2024 | ||||||
| ROBOTS: NOINDEX | ||||||
| --- | ||||||
|
|
||||||
| # vcpkg: Overview | ||||||
|
|
||||||
| vcpkg helps you manage C and C++ libraries on Windows, Linux and MacOS. | ||||||
| This tool and ecosystem are constantly evolving, and we always appreciate contributions! | ||||||
|
|
||||||
| Please see the main repository at <https://github.com/microsoft/vcpkg> for all feature discussion, issue | ||||||
| tracking, and edits to which libraries are available. | ||||||
|
|
||||||
| # vcpkg-tool: Overview | ||||||
|
|
||||||
| This repository contains the contents formerly at <https://github.com/microsoft/vcpkg> in the | ||||||
| `toolsrc` tree, and build support. | ||||||
|
|
||||||
| # vcpkg-artifacts | ||||||
|
|
||||||
| vcpkg-artifacts is currently in 'preview' -- there will most certainly be changes between now | ||||||
| and when the tool is 'released' based on feedback. | ||||||
|
|
||||||
| 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. | ||||||
|
|
||||||
| It | ||||||
| - integrates itself into your shell (PowerShell, CMD, bash/zsh) | ||||||
| - can restore artifacts according to a manifest that follows one’s code | ||||||
| - provides discoverability interfaces | ||||||
|
|
||||||
| ## Installation | ||||||
|
|
||||||
| While the usage of `vcpkg-artifacts` is the same on all platforms, the installation/loading/removal is slightly different depending on the platform you're using. | ||||||
|
|
||||||
| `vcpkg-artifacts` don't persist any changes to the environment, nor do they automatically add themselves to the start-up environment. If you wish to make it load in a window, you can just execute the script. Manually adding that in your profile will load it in every new window. | ||||||
|
|
||||||
| <hr> | ||||||
|
|
||||||
| ## Install/Use/Remove | ||||||
|
|
||||||
| | OS | Install | Use | Remove | | ||||||
| |-----------------|-----------------------------------------------------|-----------------------|---------------------------------| | ||||||
| | **PowerShell/Pwsh** |`iex (iwr -useb https://aka.ms/vcpkg-init.ps1)` |` . ~/.vcpkg/vcpkg-init.ps1` | `rmdir -recurse -force ~/.vcpkg` | | ||||||
| | **Linux/OSX** |`. <(curl https://aka.ms/vcpkg-init.sh -L)` |` . ~/.vcpkg/vcpkg-init` | `rm -rf ~/.vcpkg` | | ||||||
| | **CMD Shell** |`curl -LO https://aka.ms/vcpkg-init.cmd && .\vcpkg-init.cmd` |`%USERPROFILE%\.vcpkg\vcpkg-init.cmd` | `rmdir /s /q %USERPROFILE%\.vcpkg` | | ||||||
|
|
||||||
| ## Glossary | ||||||
|
|
||||||
| | Term | Description | | ||||||
| |------------|-----------------------------------------------------| | ||||||
| | `artifact` | An archive (.zip or .tar.gz-like), package (.nupkg, .vsix) binary inside which build tools or components thereof are stored. | | ||||||
| | `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_) | | ||||||
| | `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.) | | ||||||
|
|
||||||
|
|
||||||
| # Contributing | ||||||
|
|
||||||
| Please refer to the "contributing" section of the | ||||||
| [main `README.md`](https://github.com/microsoft/vcpkg/blob/master/README.md). | ||||||
|
|
||||||
| This project has adopted the [Microsoft Open Source Code of Conduct][contributing:coc]. | ||||||
| For more information see the [Code of Conduct FAQ][contributing:coc-faq] | ||||||
| or email [[email protected]](mailto:[email protected]) | ||||||
| with any additional questions or comments. | ||||||
|
|
||||||
| [contributing:submit-issue]: https://github.com/microsoft/vcpkg/issues/new/choose | ||||||
| [contributing:submit-pr]: https://github.com/microsoft/vcpkg/pulls | ||||||
| [contributing:coc]: https://opensource.microsoft.com/codeofconduct/ | ||||||
| [contributing:coc-faq]: https://opensource.microsoft.com/codeofconduct/ | ||||||
|
|
||||||
| ## Windows Contributing Prerequisites | ||||||
|
|
||||||
| * Install Visual Studio and the C++ workload | ||||||
| * Install Node.JS by downloading a 16.x copy from https://nodejs.org/en/ | ||||||
| * `npm install -g @microsoft/rush` | ||||||
|
|
||||||
| ## Ubuntu 22.04 Contributing Prerequisites | ||||||
|
|
||||||
| ``` | ||||||
| curl -fsSL https://deb.nodesource.com/setup_16.x | sudo -E bash - | ||||||
| sudo apt update | ||||||
| sudo apt install nodejs cmake ninja-build gcc build-essential git zip unzip | ||||||
| sudo npm install -g @microsoft/rush | ||||||
| ``` | ||||||
|
|
||||||
| # License | ||||||
|
|
||||||
| The product code in this repository is licensed under the [MIT License](LICENSE.txt). The tests | ||||||
|
There was a problem hiding this comment. I think this link will need to be updated to still work on Learn. |
||||||
| 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 | ||||||
| [Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general). | ||||||
|
There was a problem hiding this comment.
Suggested change
Suggestion: remove the en-us from the URL so users of other languages can easily view in their preferred language. |
||||||
| 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. | ||||||
|
|
||||||
| # Telemetry | ||||||
|
|
||||||
| vcpkg collects usage data in order to help us improve your experience. | ||||||
| The data collected by Microsoft is anonymous. | ||||||
| You can opt-out of telemetry by re-running the bootstrap-vcpkg script with -disableMetrics, | ||||||
| passing --disable-metrics to vcpkg on the command line, | ||||||
| or by setting the VCPKG_DISABLE_METRICS environment variable. | ||||||
|
|
||||||
| Read more about vcpkg telemetry at https://learn.microsoft.com/vcpkg/about/privacy | ||||||
| in the main repository | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.