Commit Graph

78 Commits

Author SHA1 Message Date
David Matson
491d01935a
Recommend self-contain repos/submodules regardless of build system. (#32698)
Fixes #31466.
2023-08-03 10:28:10 -07:00
Billy Richardson
414124abc9
Fix broken documentation links in readme (#32009) 2023-06-14 13:53:09 -07:00
chausner
33a257fbf9
Tweak link in README (#29107)
* Remove outdated paragraph from README

* Turn path in README into a link

* Revert "Remove outdated paragraph from README"

This reverts commit bdd80c0adf.

* Change link

---------

Co-authored-by: chausner <chausner@users.noreply.github.com>
2023-03-06 15:46:35 -08:00
Victor Romero
54cc53c434
[docs] Add stubs to redirect to Microsoft Learn (#29820) 2023-02-23 17:11:56 -08:00
Robert Schumacher
547c030e68
[vcpkg docs] Remove docs migrated to https://learn.microsoft.com/vcpkg and Microsoft/vcpkg-docs (#28350)
* [docs] Remove embedded documentation in favor of learn.microsoft.com

* [docs] Remove validation workflow
2023-02-16 11:36:51 -08:00
Robert Schumacher
7b78396b3f
[docs] Revert FetchContent section (#27311)
* [docs] Mark FetchContent as experimental

* [docs] Revert 'FetchContent' section

It is not a supported, designed, or tested method and has several significant shortcomings.
2022-11-01 15:32:26 -07:00
jpr42
aed63d2200
Vcpkg via FetchContent (#27158)
Show how to easily incorporate vcpkg into a CMake project without git submodules
2022-10-14 16:28:05 -07:00
Hiroshi Yoshioka
9ff91df90a
Typo "Github"→"GitHub" (#26441)
* Typo "Github"→"GitHub"

https://github.com/microsoft/vcpkg/blob/master/README.md
#PingMSFTDocs

* Typo "Github"→"GitHub"

https://github.com/microsoft/vcpkg/blob/master/README_fr.md
#PingMSFTDocs

* Typo "Github"→"GitHub"(README_ko_KR.md)

https://github.com/microsoft/vcpkg/blob/master/README_ko_KR.md
#PingMSFTDocs

* Typo "Github"→"GitHub"

https://github.com/microsoft/vcpkg/blob/master/README_zh_CN.md
#PingMSFTDocs
2022-08-22 09:18:59 -07:00
Robert Schumacher
8639e65b88
[docs] Split integration.md per Build System. (#24737)
* Split integration.md per Build System.

Centralize buildsystem configuration.

* PR comment
2022-05-17 17:12:53 -07:00
Jack·Boos·Yu
f68e901854
[vcpkg docs] Add double quotes to toolchain path (#24649)
* [vcpkg docs] Add double quotes to toolchain path

* Apply changes
2022-05-12 16:53:26 -07:00
Billy O'Neal
e0ee67c88f
[security development lifecycle] comply by adding security guidance. (#19834)
Resolves https://devdiv.visualstudio.com/DevDiv/_workitems/edit/1336590

Drive-by: remove useless build status icon.
2022-01-06 13:39:03 -08:00
GU
ab4cd0c72a
[vcpkg docs] Update Table of Content and Korean Readme (#22165)
* Update korean Readme

* Add another language

* Delete removed section on ToC
2022-01-04 14:52:51 -08:00
autoantwort
adc3cec1fc
Update readme for macOS (#21952) 2021-12-09 17:33:51 -08:00
Simon Sobisch
f60f3a628c
README updated to include tool repo (#21127) 2021-11-13 11:05:14 -08:00
Ronald
c69a37472b
[vcpkg docs] Make telemetry section of README.md clearer (#20412)
* Update README.md

format section telemetry to make it more clear

* Update README.md
2021-09-29 08:41:39 -07:00
Phoebe
a7b8f58dad
[vcpkg docs] Update readme.md (#18253)
* [vcpkg docs] Update readme.md

* Update README.md

* Update README.md

Co-authored-by: Robert Schumacher <roschuma@microsoft.com>
2021-06-03 12:43:05 -07:00
Mark Ingram
6b0ebbb581
[Readme] Added x64 triplet note for Windows Quick Start (#17218) 2021-04-12 10:54:53 -07:00
Akshay Shekher
7524d9d4c4
[docs] Updates links to documentation in repo's root README.md (#16805)
Co-authored-by: Akshay <akshay.shekher@gmail.com>
2021-03-22 15:15:29 -07:00
Aki
dec0282169
[vcpkg] Add korean version Readme (#14310)
* Project Start

Co-authored-by:  jiyuPk
<wltmfdmsdnjf@gmail.com>

* Update README_ko_KR.md

1차 문서 거의 다 완성 중

Co-Authored-By: GU <64261175+jiyuPk@users.noreply.github.com>

* Update README_ko_KR.md

* Fix typo ko_KR

Co-authored-by: GU <64261175+jiyuPk@users.noreply.github.com>
Co-authored-by: Lily <47812810+LilyWangL@users.noreply.github.com>
2020-11-12 14:34:55 -08:00
x0rld
72abcc5681
[vcpkg] translate the README to french (#13971) 2020-10-30 13:21:48 -07:00
Jonathan Guzmán
cabe5d0b7b
[vcpkg/docs] Add Spanish README (#13735)
Co-authored-by: JackBoosY <yuzaiyang@beyondsoft.com>
2020-09-30 09:18:49 -07:00
Jack·Boos·Yu
26b365c608
[documentation] Fix manifest link (#13685)
* [document] Fix manifest docs

* Sync to Chinese document

* add empty line

* Fix manifest link
2020-09-24 11:36:44 -07:00
nicole mazzuca
0fec1340eb
[vcpkg manifest] Add documentation! (#13488)
* [vcpkg docs] add docs for manifest files

These are just for the maintainer docs,
not user docs.

* [vcpkg] EBNF-ify platform expression parsing

this modifies nothing about what strings are accepted or rejected,
it just moves stuff around.

also adds tests.

* [vcpkg docs] add manifest mode example

* [wip] docs for augustin

also fix tabs

* [vcpkg manifest] switch to using maps for features

* Apply suggestions from code review

* un-experimentize format-manifest

* flesh out the user manifest mode docs

* CRs

* billy CRs

* final personal pass-thru
2020-09-14 15:07:02 -07:00
Jiahui Chen
0b144fe80d
[Readme] fix typo & sync content (#13237) 2020-08-31 09:07:55 -07:00
Jonathan Guzmán
a64399e0a6
[typo] Fix incorrect Path in readme (#13066) 2020-08-21 11:46:35 -07:00
Varun Agrawal
e6cc4b49e7
[vcpkg] Fix typo in link for installing and using packages (#12661) 2020-07-31 11:38:02 -07:00
nicole mazzuca
811cb0cc38
[vcpkg README] Fix links (#12317)
Co-authored-by: Jack·Boos·Yu <47264268+JackBoosY@users.noreply.github.com>
Co-authored-by: JackBoosY <yuzaiyang@beyondsoft.com>
2020-07-07 22:08:09 -07:00
nicole mazzuca
ee218d3065
[vcpkg docs] new README/Quick Start guide (#12093)
* [vcpkg docs] new README/Quick Start guide

* some CRs

* add VS+CMake instructions

* add CLion instructions

* Update chinese readme, add link url.

* Update README_zh_CN.md

Co-authored-by: Phoebe <20694052+PhoebeHui@users.noreply.github.com>

* Update README_zh_CN.md

Co-authored-by: Phoebe <20694052+PhoebeHui@users.noreply.github.com>

* Update README_zh_CN.md

Co-authored-by: Phoebe <20694052+PhoebeHui@users.noreply.github.com>

* Update README_zh_CN.md

Co-authored-by: Phoebe <20694052+PhoebeHui@users.noreply.github.com>

* Update README_zh_CN.md

Co-authored-by: Phoebe <20694052+PhoebeHui@users.noreply.github.com>

* Update README_zh_CN.md

Co-authored-by: Phoebe <20694052+PhoebeHui@users.noreply.github.com>

* Update README_zh_CN.md

Co-authored-by: Phoebe <20694052+PhoebeHui@users.noreply.github.com>

* Update README_zh_CN.md

Co-authored-by: Phoebe <20694052+PhoebeHui@users.noreply.github.com>

* Update README_zh_CN.md

Co-authored-by: Phoebe <20694052+PhoebeHui@users.noreply.github.com>

* Update README_zh_CN.md

Co-authored-by: Phoebe <20694052+PhoebeHui@users.noreply.github.com>

* CRs

* Fix some describe and link

* Re-fix url link

* Re-fix url link

* Re-fix url link

Co-authored-by: JackBoosY <yuzaiyang@beyondsoft.com>
Co-authored-by: Jack·Boos·Yu <47264268+JackBoosY@users.noreply.github.com>
Co-authored-by: Phoebe <20694052+PhoebeHui@users.noreply.github.com>
2020-07-07 10:53:14 -07:00
nicole mazzuca
8706cb82cd
[vcpkg README] Add #include<C++> channel (#11750)
* [vcpkg README] Add #include<C++> channel

* Fix includecpp -> www.includecpp

the SSL is only valid for www.*
2020-06-05 11:00:43 -07:00
nicole mazzuca
09319cd79e
[vcpkg metrics] Allow someone to opt out after build (#11542)
* [vcpkg metrics] start using json library

Additionally, add floats to the JSON library since they're required.

* [vcpkg metrics] allow users to disable metrics after the build

Additionally, as a drive by, fix UUID generation

* fix metrics data

* code review
2020-05-29 14:09:03 -07:00
Billy O'Neal
3eb3b62717
Add telemetry notice to README.md. (#11171) 2020-05-05 12:34:48 -07:00
Billy O'Neal
a070c1fffd
[vcpkg] point README.md to the correct status badge. (#11175) 2020-05-05 12:05:34 -07:00
Billy Robert O'Neal III
b8755728ab [vcpkg] Onboard Linux to VMSS, open 'git' port, and switch back to Azure Spot
* Adds scripts to generate scale sets for testing Linux.
    * Note workaround for https://github.com/microsoft/azure-pipelines-agent/pull/2929
* Switches Windows validation to 'Spot' VMs.
* Opens the git port 9418.
* Removes provisioning of the no longer used 'logs' file share.
* Changes Azure region to 'westus2', which is cheaper.
* Adds +x to all the scripts in scripts/azure-pipelines.
* Use 'xml-results' for all platforms instead of 'raw xml results' on Windows.
2020-04-30 21:51:31 -07:00
Rene Rivera
bd02300f06
[vcpkg] Fix slack link to current, correct, location. (#11009) 2020-04-24 14:58:49 -07:00
Robert Schumacher
5fca4998fa
Update README.md 2019-11-22 15:10:57 -08:00
Kcchouette
383d5ed48c
Adding the gcc+=7 prerequisite on the README 2019-11-07 15:44:33 +01:00
dan-shaw
e8bb299bbb
Update README.md (#8894) 2019-11-04 17:00:30 -08:00
Quazi Irfan
8bfae5624f Added instruction about libraries not available in vcpkg catalog (#6718)
* Add instruction for library unavailable in vcpkg catalog
2019-06-10 10:57:17 -07:00
Leonard Mosescu
d8e168c1e8 Update the notes on prerequisites (#6128)
Future proof the instructions
2019-04-17 13:45:58 -07:00
Alexander Karatarakis
fed9a24526 [autocomplete] Add tab-completion support for bash 2018-12-13 14:02:02 -08:00
Phil Christensen
73f51d6aa8
Merge pull request #4746 from TartanLlama/master
Rename example documents and add GitHub packaging example
2018-11-19 14:10:27 -08:00
Simon Brand
dc8503bb02 Fix typo 2018-11-16 15:04:10 +00:00
Simon Brand
077b7f1378 Add packaging GitHub repo example 2018-11-16 11:24:19 +00:00
Alexander Karatarakis
f598d6c30f [cmake] Update to 3.12.4 2018-11-15 14:09:53 -08:00
Simon Brand
56c94a8102 Rename example documents
The current names and titles of the examples put too much emphasis on the package which is being demonstrated rather than the concept. This can be jarring for newcomers. This patch renames them to put the emphasis on the concept instead.
2018-11-15 11:23:34 +00:00
Cyan/Jos
7bc26c173b only "optional:" is in italics rather than "optional: CMake 3.10.2" 2018-10-05 12:41:22 +08:00
Michael Vetter
c63b563752 Rename 'Ubuntu' with 'Linux' in README.md (#4393)
Let's not be biased or propagate a certain Linux distribution over
others.
2018-10-02 14:46:42 -07:00
Robert Schumacher
13e19f10ea
[README.md] Remove outdated VSTS badge 2018-08-08 11:06:08 -07:00
Dandigit
f14a6e79b3 Fix grammar issue (#3938) 2018-07-30 12:04:13 -07:00
Mohammad Mahdi Rahimi
d2bc81f921
Update README.md
fix typo: add `.git` extention
2018-06-26 17:05:28 +04:30