Skip to content

Commit

Permalink
updated readme C++ ins
Browse files Browse the repository at this point in the history
  • Loading branch information
jafermarq committed Oct 8, 2024
1 parent 36e9957 commit d74d13e
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion examples/quickstart-cpp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,9 @@ quickstart-cpp

### Install dependencies and project

> [!NOTE]
> Building the C++ components currently only works in Ubuntu 22.
In this example, `SuperLink` and `ServerApp` use Flower's Python package, while the `SuperNodes` are C++ executables. We therefore need: (1) a Python environment with Flower installed; and (2) to build the `SuperNode` binaries.

1. **Prepare for `SuperLink` and `ServerApp`**
Expand All @@ -60,7 +63,13 @@ In this example, `SuperLink` and `ServerApp` use Flower's Python package, while

2. **Build the `SuperNode` executables**

Ensure you have [CMake installed](https://cliutils.gitlab.io/modern-cmake/chapters/intro/installing.html) in your system. Then, build the binaries:
Ensure you have `CMake` and other build tools installed in your system.

```shell
sudo apt-get install -y clang-format cmake g++ clang-tidy cppcheck
```

Then, build the binaries:

```bash
cmake -S . -B build
Expand Down

0 comments on commit d74d13e

Please sign in to comment.