diff options
| author | Simon Brand <tartanllama@gmail.com> | 2018-11-15 11:18:48 +0000 |
|---|---|---|
| committer | Simon Brand <tartanllama@gmail.com> | 2018-11-15 11:23:34 +0000 |
| commit | 56c94a81027dae14ea8adabcbda800d0f7c10d0b (patch) | |
| tree | 1661c9711c5317e1bb6acc786e28700db1698caf /docs/about | |
| parent | f1eb3aa4b95540a8fb4a8e8d341e4c08136bd756 (diff) | |
| download | vcpkg-56c94a81027dae14ea8adabcbda800d0f7c10d0b.tar.gz vcpkg-56c94a81027dae14ea8adabcbda800d0f7c10d0b.zip | |
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.
Diffstat (limited to 'docs/about')
| -rw-r--r-- | docs/about/faq.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/about/faq.md b/docs/about/faq.md index 0178e051a..57b908f48 100644 --- a/docs/about/faq.md +++ b/docs/about/faq.md @@ -10,12 +10,12 @@ Yes! See [the `export` command](../users/integration.md#export). The `vcpkg update` command lists all packages which are out-of-sync with your current portfiles. To update a package, follow the instructions in the command. ## How do I get more libraries? -The list of libraries is enumerated from the [`ports\`](https://github.com/Microsoft/vcpkg/blob/master/ports) directory. By design, you can add and remove libraries from this directory as you see fit for yourself or your company -- see [Example #2](../examples/packaging-zlib.md). +The list of libraries is enumerated from the [`ports\`](https://github.com/Microsoft/vcpkg/blob/master/ports) directory. By design, you can add and remove libraries from this directory as you see fit for yourself or your company -- see our [packaging example](../examples/packaging-zipfiles.md). We recommend cloning directly from [GitHub](https://github.com/microsoft/vcpkg) and using `git pull` to update the list of portfiles. Once you've updated your portfiles, `vcpkg update` will indicate any installed libraries that are now out of date. ## Can I build a private library with this tool? -Yes. Follow [our Packaging zlib Example](../examples/packaging-zlib.md) for creating a portfile using a fake URL. Then, either pre-seed the `downloads\` folder with a zip containing your private sources or replace the normal calls to `vcpkg_download_distfile` and `vcpkg_extract_source_archive` with functions that unpack your source code. +Yes. Follow [our packaging zlib Example](../examples/packaging-zipfiles.md) for creating a portfile using a fake URL. Then, either pre-seed the `downloads\` folder with a zip containing your private sources or replace the normal calls to `vcpkg_download_distfile` and `vcpkg_extract_source_archive` with functions that unpack your source code. ## Can I use a prebuilt private library with this tool? Yes. The `portfile.cmake` for a library is fundamentally a script that places the headers and binaries into the correct arrangement in the `${CURRENT_PACKAGES_DIR}`, so to pull in prebuilt binaries you can write a portfile which directly downloads and arranges the files. |
