diff options
| author | Phil Christensen <philc@microsoft.com> | 2018-11-19 14:10:27 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-11-19 14:10:27 -0800 |
| commit | 73f51d6aa8aa3fd23e8b3996a2f7dedbbf49d6cc (patch) | |
| tree | 41b1e8007bd4116a0f756b9083b6bee3eb8a0aef /docs/examples/packaging-github-repos.md | |
| parent | 6633d421b7f53ba6faadb8ee85ef806718dfd64b (diff) | |
| parent | dc8503bb02ba8afc7641f53fd25d1566d44a9f41 (diff) | |
| download | vcpkg-73f51d6aa8aa3fd23e8b3996a2f7dedbbf49d6cc.tar.gz vcpkg-73f51d6aa8aa3fd23e8b3996a2f7dedbbf49d6cc.zip | |
Merge pull request #4746 from TartanLlama/master
Rename example documents and add GitHub packaging example
Diffstat (limited to 'docs/examples/packaging-github-repos.md')
| -rw-r--r-- | docs/examples/packaging-github-repos.md | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/docs/examples/packaging-github-repos.md b/docs/examples/packaging-github-repos.md new file mode 100644 index 000000000..af2e6141a --- /dev/null +++ b/docs/examples/packaging-github-repos.md @@ -0,0 +1,59 @@ +## Packaging Github Repos Example: libogg
+### Create the CONTROL file
+The `CONTROL` file is a simple set of fields describing the package's metadata.
+
+*For libogg, we'll create the file `ports\libogg\CONTROL` with the following contents:*
+```no-highlight
+Source: libogg
+Version: 1.3.3
+Description: Ogg is a multimedia container format, and the native file and stream format for the Xiph.org multimedia codecs.
+```
+
+### Create the portfile
+`portfile.cmake` describes how to build and install the package. First we include `vcpkg_common_functions` to give us utilities for carrying this out:
+
+```no-highlight
+include(vcpkg_common_functions)
+```
+
+Now we download the project from Github with [`vcpkg_from_github`](../maintainers/vcpkg_from_github.md):
+
+```no-highlight
+vcpkg_from_github(
+ OUT_SOURCE_PATH SOURCE_PATH
+ REPO xiph/ogg
+ REF v1.3.3
+ SHA512 0bd6095d647530d4cb1f509eb5e99965a25cc3dd9b8125b93abd6b248255c890cf20710154bdec40568478eb5c4cde724abfb2eff1f3a04e63acef0fbbc9799b
+ HEAD_REF master
+)
+```
+
+The important parts to update are `REPO` for the GitHub repository path, `REF` for a stable tag/commit to use, and `SHA512` with the checksum of the downloaded zipfile (you can get this easily by setting it to `1`, trying to install the package, and copying the checksum).
+
+Finally, we configure the project with CMake, install the package, and copy over the license file:
+
+```no-highlight
+vcpkg_configure_cmake(
+ SOURCE_PATH ${SOURCE_PATH}
+ PREFER_NINJA
+)
+vcpkg_install_cmake()
+file(INSTALL ${SOURCE_PATH}/COPYING DESTINATION ${CURRENT_PACKAGES_DIR}/share/libogg RENAME copyright)
+```
+
+Check the documentation for [`vcpkg_configure_cmake`](../maintainers/vcpkg_configure_cmake.md) and [`vcpkg_install_cmake`](../maintainers/vcpkg_install_cmake.md) if your package needs additional options.
+
+Now you can run `vcpkg install libogg` to build and install the package.
+
+### Suggested example portfiles
+In the `ports\` directory are many libraries that can be used as examples, including many that are not based on CMake.
+
+- Header only libraries
+ - rapidjson
+ - range-v3
+- MSBuild-based
+ - cppunit
+ - mpg123
+- Non-CMake, custom buildsystem
+ - openssl
+ - ffmpeg
|