Factor vcpkg out of CI scripts and into main stream (#318)

* Factor vcpkg out of CI scripts and into main stream

* Update README.md

* Update .appveyor.yml

Author: PerdixOfMars

.appveyor.yml

@@ -45,10 +45,7 @@ install:
   - git checkout 58950f88544e4637524dbd6a01d0317cf4cb77fc
   - .\bootstrap-vcpkg.bat
   - cd %appveyor_build_folder%
-  - call "%VCPKG_ROOT%\vcpkg" install boost-container-hash:%platform%-windows
-  - call "%VCPKG_ROOT%\vcpkg" install boost-core:%platform%-windows
-  - call "%VCPKG_ROOT%\vcpkg" install boost-range:%platform%-windows
-  - call "%VCPKG_ROOT%\vcpkg" install gtest:%platform%-windows
+  - call "%VCPKG_ROOT%\vcpkg" install --triplet %platform%-windows
 
 build_script:
   - mkdir build

.github/workflows/build.yml

@@ -27,14 +27,11 @@ jobs:
       - name: Setup vcpkg (with binary caching)
         uses: lukka/run-vcpkg@v11
         with:
-          runVcpkgInstall: false
+          runVcpkgInstall: true
+          vcpkgJsonGlob: "${{ github.workspace }}/vcpkg.json"
           vcpkgDirectory: "${{ github.workspace }}/.vcpkg"
           vcpkgGitCommitId: "58950f88544e4637524dbd6a01d0317cf4cb77fc"
 
-      - name: Install dependencies
-        shell: bash
-        run: $VCPKG_ROOT/vcpkg install boost-container-hash gtest
-
       - name: Create Build Environment
         run: cmake -E make_directory ${{runner.workspace}}/terminalpp/build
 
@@ -72,14 +69,11 @@ jobs:
       - name: Setup vcpkg (with binary caching)
         uses: lukka/run-vcpkg@v11
         with:
-          runVcpkgInstall: false
+          runVcpkgInstall: true
+          vcpkgJsonGlob: "${{ github.workspace }}/vcpkg.json"
           vcpkgDirectory: "${{ github.workspace }}/.vcpkg"
           vcpkgGitCommitId: "58950f88544e4637524dbd6a01d0317cf4cb77fc"
 
-      - name: Install dependencies
-        shell: bash
-        run: $VCPKG_ROOT/vcpkg install boost-container-hash gtest
-
       - name: Extract branch name
         shell: bash
         run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"

README.md

@@ -7,24 +7,59 @@
 [![Coverage Status](https://coveralls.io/repos/github/KazDragon/terminalpp/badge.svg?branch=master)](https://coveralls.io/github/KazDragon/terminalpp?branch=master) 
 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/a2741e8f7abf49bc8b496fbf8b51b983)](https://www.codacy.com/gh/KazDragon/terminalpp/dashboard?utm_source=github.com&utm_medium=referral&utm_content=KazDragon/terminalpp&utm_campaign=Badge_Grade)
 
-# Terminal++
 A C++ library for interacting with ANSI/VT100 terminal or terminal emulator displays.
 
-# Requirements
+## Requirements
+
+- C++20 compiler
+- CMake 3.16+
+- Boost 1.69+ (required)
+- Google Test (for tests only)
+
+## Build And Install (From Source)
+
+```bash
+git clone https://github.com/KazDragon/terminalpp.git
+cd terminalpp
+
+cmake -S . -B build \
+  -DCMAKE_BUILD_TYPE=Release \
+  -DCMAKE_INSTALL_PREFIX="$HOME/.local"
+
+cmake --build build --config Release
+cmake --install build --config Release
+```
+
+## Dependency Resolution With vcpkg
 
-Terminal++ requires a C++20 compiler and the following libraries:
-  * Boost (At least version 1.69.0)
-  * (For testing only) Google Test
+Terminal++ can resolve dependencies automatically through `vcpkg`:
 
-# Installation - CMake
+```bash
+cmake -S . -B build \
+  -DCMAKE_BUILD_TYPE=Release \
+  -DCMAKE_TOOLCHAIN_FILE="$VCPKG_ROOT/scripts/buildsystems/vcpkg.cmake"
+```
+
+When using manifest mode (`vcpkg.json` in this repository), configure will
+trigger dependency installation automatically.
+
+## Consume From CMake (Installed Package)
+
+```cmake
+cmake_minimum_required(VERSION 3.16)
+project(my_app LANGUAGES CXX)
 
-Terminal++ can be installed from source using CMake.  This requires Boost and any other dependencies to have been installed beforehand, using their own instructions, or for the call to `cmake --configure` to be adjusted appropriately (e.g. `-DBOOST_ROOT=...`).  If you do not wish to install into a system directory, and thus avoid the use of sudo, you can also pass `-DCMAKE_INSTALL_PREFIX=...` into the `cmake --configure` call.
+find_package(terminalpp CONFIG REQUIRED)
 
-    git clone https://github.com/KazDragon/terminalpp.git && cd terminalpp
-    mkdir build && cd build
-    cmake --configure -DCMAKE_BUILD_TYPE=Release ..
-    cmake --build .
-    sudo cmake --install .
+add_executable(my_app main.cpp)
+target_link_libraries(my_app PRIVATE KazDragon::terminalpp)
+```
+
+If installed to a non-system prefix:
+
+```bash
+cmake -S . -B build -DCMAKE_PREFIX_PATH="$HOME/.local"
+```
 
 # Features / Roadmap
 

vcpkg-configuration.json

@@ -0,0 +1,7 @@
+{
+    "$schema": "https://raw.githubusercontent.com/microsoft/vcpkg-tool/main/docs/vcpkg-configuration.schema.json",
+    "default-registry": {
+        "kind": "builtin",
+        "baseline": "58950f88544e4637524dbd6a01d0317cf4cb77fc"
+    }
+}

vcpkg.json

@@ -0,0 +1,9 @@
+{
+    "$schema": "https://raw.githubusercontent.com/microsoft/vcpkg-tool/main/docs/vcpkg.schema.json",
+    "name": "terminalpp",
+    "version-string": "0.0.0",
+    "dependencies": [
+        "boost-container-hash",
+        "gtest"
+    ]
+}