Commit Graph

14 Commits

Author SHA1 Message Date
TeeVenDick
43e41bb2b0
Fix broken doc link (#14833) 2020-11-29 13:44:03 -08: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
Pascal Thomet
55be137d5b
[vcpkg] Improve Android doc (triplets, usage with cmake and prefab) (#11264)
* Android: add docs/examples/vcpkg_android_example_cmake/

* Add docs/users/android.md

* Improve Android prefab doc

Following additional informations given by @atkawa7 at
https://github.com/microsoft/vcpkg/pull/11264

* Link to android.md
* Update the prefab usage instructions: "vcpkg install"
    the 4 archs before exporting a prefab
* added --prefab-debug flag
* added gradle integration info
* reviewed the prefab output directory structure
  (from a dump of an actual export)

* docs/users/triplets.md: link to android.md

* docs/index.md: link to android.md

* android.md: specify 2 possibiities for android_ndk_home

* Added examples/vcpkg_android_example_cmake_script/cmake/vcpkg_android.cmake

Usage:

1. Main CMakeLists:
  if (VCPKG_TARGET_ANDROID)
      include("cmake/vcpkg_android.cmake")
  endif()

2. cmake invocation:
  cmake .. -DVCPKG_TARGET_ANDROID=ON -DANDROID_ABI=armeabi-v7a

* trigger pipeline build

* trigger pipelines
2020-05-13 16:42:13 -07:00
nicole mazzuca
2a81a2d322 [vcpkg docs] More tool maintainer docs! (#7821)
* [vcpkg docs] Add benchmarking 🏎 to the docs!

Also, minor changes to the testing docs.

* add documentation for the layout of the project
2019-08-24 11:36:12 -07:00
nicole mazzuca
165907550c
Update tests, and add documentation! (#7506)
This PR does the following:

* fix tests -- now, they're always built in the CMake scripts, and they work on VS2015
  *add a new flag, BUILD_TESTING, which allows one to turn off testing builds
* Add documentation for running tests
2019-08-02 09:52:39 -07:00
Robert Schumacher
9cfcc71146
[docs] Add maintainer guidelines (#6871)
* [maintainer-guide] Initial commit of maintainer guidelines

* [maintainer-guide] Rearrange sections

* [maintainer-guide] Add note about GitHub Draft PRs

* [maintainer-guide] Improvements

* [maintainer-guide] Address comments about versioning conventions

* [maintainer-guide] Add section about how portfiles interact with CMakeLists.txt

* [maintainer-guidelines] Add link from docs index
2019-06-21 21:33:29 -07:00
Billy O'Neal
cf7e2f3906 Allow redirection of the downloads folder with an environment variable. (#4883)
* Add detection for VCPKG_DOWNLOADS environment variable in vcpkgpaths.cpp.

* Pass the downloads directory from VcpkgPaths to cmake.

* Also fixup bootstrap on *nix.

* Make error message a little prettier.

* Make that bash script actually work :)

* [vcpkg] Alter Optional<> usage style

* [vcpkg-docs] Add section on Environment Variables to the docs
2018-12-11 11:48:41 -08:00
Simon Brand
077b7f1378 Add packaging GitHub repo example 2018-11-16 11:24:19 +00: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
Alexander Karatarakis
39c70573df Update documentation 2018-06-08 16:33:38 -07:00
Eric Mittelette
1d39174ca5 adding a blog link in the doc 2018-05-16 09:25:44 -07:00
Joel Clay
f51b9d403a
Add crossplatform announcement to docs 2018-04-24 18:52:32 -04:00
Robert Schumacher
76b754e52d [vcpkg-docs] Initial commit of triplets documentation 2017-06-07 14:32:54 -07:00
Robert Schumacher
49cd399586 [vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs. 2017-05-28 14:15:13 -07:00