Skip to content

Commit

Permalink
Update scripts and docs (#227)
Browse files Browse the repository at this point in the history
* Documents and Readme.md

Documents and Readme.md improvements and adjustments:
- moved images from img to _static folder
- adjusted the conf.py and removed txt files from build proces
- removed full-upgrade step from setup_build_env.sh
- docs updates and improvemetns

* Update scripts and docs

Signed-off-by: Kasiewicz, Marek <[email protected]>

---------

Signed-off-by: Kasiewicz, Marek <[email protected]>
Co-authored-by: Milosz Linkiewicz <[email protected]>
  • Loading branch information
Sakoram and Mionsz authored Oct 9, 2024
1 parent 3bffd74 commit b017fcc
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 5 deletions.
5 changes: 3 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,17 +84,18 @@ The Media Communications Mesh (MCM) enables efficient, low-latency media transpo
- XDP-tools with eBpf: Follow the simple guide [XDP-tools](https://github.com/xdp-project/xdp-tools.git) for installation.
- libfabric: Follow the [libfabric from source](https://github.com/ofiwg/libfabric?tab=readme-ov-file#building-and-installing-libfabric-from-source) for installation.
- MTL: Follow the [MTL setup guide](https://github.com/OpenVisualCloud/Media-Transport-Library/blob/main/doc/build.md) for installation.
- E810 driver: Follow The [MTL NIC setup guide](https://github.com/OpenVisualCloud/Media-Transport-Library/blob/main/doc/e810.md)
- gRPC: Refer to the [gRPC documentation](https://grpc.io/docs/languages/cpp/quickstart/) for installation instructions.
- Install required packages:

- Ubuntu/Debian
```bash
sudo apt-get update
sudo apt-get install libbsd-dev cmake make
sudo apt-get install libbsd-dev cmake make libibverbs-dev librdmacm-dev dracut
```
- Centos stream
```bash
sudo yum install -y libbsd-devel cmake make
sudo yum install -y libbsd-devel cmake make libibverbs-devel librdmacm-devel dracut
```

- Install the irdma driver and libfabric
Expand Down
7 changes: 5 additions & 2 deletions scripts/setup_build_env.sh
Original file line number Diff line number Diff line change
Expand Up @@ -123,14 +123,17 @@ function install_ubuntu_package_dependencies()
gcc-multilib \
systemtap-sdt-dev \
librdmacm-dev \
libibverbs-dev \
libfdt-dev \
autoconf \
automake \
autotools-dev \
libtool \
grpc-proto \
protobuf-compiler-grpc \
libgrpc10
libgrpc10 \
dracut \
linux-headers-"$(uname -r)"
}

# Build the xdp-tools project with ebpf
Expand All @@ -155,7 +158,7 @@ function lib_install_fabrics()

pushd "${LIBFABRIC_DIR}"
./autogen.sh && \
./configure && \
./configure --enable-verbs && \
make -j "${NPROC}" && \
make install
popd
Expand Down
2 changes: 1 addition & 1 deletion scripts/setup_rdma_env.sh
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ install_libfabric() {
git clone --depth 1 --branch v1.22.0 https://github.com/ofiwg/libfabric libfabric
pushd libfabric
./autogen.sh
./configure
./configure --enable-verbs
make -j$(nproc)
sudo make install
sudo ldconfig
Expand Down

0 comments on commit b017fcc

Please sign in to comment.