Skip to content

Enhance installation notes #63

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 8, 2025
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
4 changes: 2 additions & 2 deletions .github/workflows/cmake.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ on:
paths-ignore:
- '.vscode/**'
- 'LICENSE'
- 'README.md'
- '**/README.md'
pull_request:
paths-ignore:
- '.vscode/**'
- 'LICENSE'
- 'README.md'
- '**/README.md'
workflow_dispatch:

env:
Expand Down
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,9 @@

## Installation

Copy the [include](https://github.com/andreiavrammsd/cpp-channel/tree/master/include) directory to your project and add it to your include path. Or
see [CMakeLists.txt](https://github.com/andreiavrammsd/cpp-channel/blob/master/examples/cmake-project/CMakeLists.txt) from the [CMake project example](https://github.com/andreiavrammsd/cpp-channel/tree/master/examples/cmake-project).
* 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)

## Usage

Expand Down Expand Up @@ -98,7 +99,7 @@ int main() {
}
```

See [examples](https://github.com/andreiavrammsd/cpp-channel/tree/master/examples).
See [examples](https://github.com/andreiavrammsd/cpp-channel/tree/master/examples) and [documentation](https://andreiavrammsd.github.io/cpp-channel/).

<br>

Expand Down
2 changes: 1 addition & 1 deletion examples/bazel-project/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# CMake project
# Bazel project

Example of using C++ Channel in a project with Bazel.

Expand Down