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/examples | |
| 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/examples')
| -rw-r--r-- | docs/examples/installing-and-using-packages.md (renamed from docs/examples/using-sqlite.md) | 6 | ||||
| -rw-r--r-- | docs/examples/packaging-zipfiles.md (renamed from docs/examples/packaging-zlib.md) | 2 | ||||
| -rw-r--r-- | docs/examples/patching.md (renamed from docs/examples/patching-libpng.md) | 2 |
3 files changed, 5 insertions, 5 deletions
diff --git a/docs/examples/using-sqlite.md b/docs/examples/installing-and-using-packages.md index 35da141d0..50200c877 100644 --- a/docs/examples/using-sqlite.md +++ b/docs/examples/installing-and-using-packages.md @@ -1,4 +1,4 @@ -# Example: Using Sqlite +## Installing and Using Packages Example: SQLite - [Step 1: Install](#install) - [Step 2: Use](#use) @@ -10,7 +10,7 @@ <a name="install"></a> ## Step 1: Install -First, we need to know what name [Sqlite](https://sqlite.org) goes by in the ports tree. To do that, we'll run the `search` command and inspect the output: +First, we need to know what name [SQLite](https://sqlite.org) goes by in the ports tree. To do that, we'll run the `search` command and inspect the output: ```no-highlight PS D:\src\vcpkg> .\vcpkg search sqlite libodb-sqlite 2.4.0 Sqlite support for the ODB ORM library @@ -82,7 +82,7 @@ Installing new libraries will make them instantly available. ``` *Note: You will need to restart Visual Studio or perform a Build to update intellisense with the changes.* -You can now simply use File -> New Project in Visual Studio 2015 or Visual Studio 2017 and the library will be automatically available. For Sqlite, you can try out their [C/C++ sample](https://sqlite.org/quickstart.html). +You can now simply use File -> New Project in Visual Studio 2015 or Visual Studio 2017 and the library will be automatically available. For SQLite, you can try out their [C/C++ sample](https://sqlite.org/quickstart.html). To remove the integration for your user, you can use `.\vcpkg integrate remove`. diff --git a/docs/examples/packaging-zlib.md b/docs/examples/packaging-zipfiles.md index 1d61cfee1..ed63637fd 100644 --- a/docs/examples/packaging-zlib.md +++ b/docs/examples/packaging-zipfiles.md @@ -1,4 +1,4 @@ -## Example 2: Packaging zlib +## Packaging Zipfiles Example: zlib ### Bootstrap with `create` First, locate a globally accessible archive of the library's sources. Zip, gzip, and bzip are all supported. Strongly prefer official sources or mirrors over unofficial mirrors. diff --git a/docs/examples/patching-libpng.md b/docs/examples/patching.md index 2337b73da..98115400e 100644 --- a/docs/examples/patching-libpng.md +++ b/docs/examples/patching.md @@ -1,4 +1,4 @@ -## Example 3: Patching libpng to work for x86-uwp +## Patching Example: Patching libpng to work for x86-uwp ### Initial error logs First, try building: |