diff --git a/.gitignore b/.gitignore index 3f3fe01..1ad214d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ .idea *build* +install docs diff --git a/.vscode/settings.json b/.vscode/settings.json index c8217dc..2ce48ab 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -4,7 +4,8 @@ "-DCPP_CHANNEL_BUILD_TESTS=ON", "-DCPP_CHANNEL_COVERAGE=ON", "-DCPP_CHANNEL_SANITIZERS=ON", - "-DCMAKE_CXX_STANDARD=11" + "-DCMAKE_CXX_STANDARD=11", + "-DCMAKE_INSTALL_PREFIX=${workspaceFolder}/install", ], "clang-tidy.fixOnSave": false, "clang-tidy.lintOnSave": false, diff --git a/CMakeLists.txt b/CMakeLists.txt index b41d369..23255af 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -27,3 +27,5 @@ endif() if (CPP_CHANNEL_BUILD_EXAMPLES) add_subdirectory(examples) endif() + +install(DIRECTORY include/ DESTINATION include) diff --git a/README.md b/README.md index 231b8e1..5856d8e 100644 --- a/README.md +++ b/README.md @@ -20,9 +20,21 @@ ## Installation +Choose one of the methods: + * Copy the [include](https://github.com/andreiavrammsd/cpp-channel/tree/master/include) directory into your project and add it to your include path. -* With [CMake](https://github.com/andreiavrammsd/cpp-channel/tree/master/examples/cmake-project) -* With [Bazel](https://github.com/andreiavrammsd/cpp-channel/tree/master/examples/bazel-project) +* [CMake FetchContent](https://github.com/andreiavrammsd/cpp-channel/tree/master/examples/cmake-project) +* [CMake install](https://cmake.org/cmake/help/latest/command/install.html) +```shell +VERSION=1.0.0 \ + && wget https://github.com/andreiavrammsd/cpp-channel/archive/refs/tags/v$VERSION.zip \ + && unzip v$VERSION.zip \ + && cd cpp-channel-$VERSION \ + && mkdir build && cd build \ + && cmake .. -DCMAKE_INSTALL_PREFIX=/usr/local \ + && sudo cmake --install . +``` +* [Bazel](https://github.com/andreiavrammsd/cpp-channel/tree/master/examples/bazel-project) ## Usage