Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.idea
*build*
install
docs
3 changes: 2 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
2 changes: 2 additions & 0 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,5 @@ endif()
if (CPP_CHANNEL_BUILD_EXAMPLES)
add_subdirectory(examples)
endif()

install(DIRECTORY include/ DESTINATION include)
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down