From 917fbca6b5faa63be3a0a67bc745333cd9faefaa Mon Sep 17 00:00:00 2001 From: Anand Bonde Date: Thu, 6 Feb 2025 13:39:36 -0800 Subject: [PATCH] [demikernel] Enhancement: update crates docs --- README.md | 1 - dpdk_bindings/README.md | 13 +++++++++++++ network_simulator/README.md | 11 +++++++++++ xdp_bindings/README.md | 12 ++++++++++++ 4 files changed, 36 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d90385763..994a08e83 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,6 @@ maintainers of the project: - [Irene Zhang](https://github.com/iyzhang) - [irene.zhang@microsoft.com](mailto:irene.zhang@microsoft.com) - [Anand Bonde](https://github.com/anandbonde) - [abonde@microsoft.com](mailto:abonde@microsoft.com) -- [Pedro Henrique Penna](https://github.com/ppenna) - [ppenna@microsoft.com](mailto:ppenna@microsoft.com) > By sending feedback, you are consenting that it may be used in the further > development of this project. diff --git a/dpdk_bindings/README.md b/dpdk_bindings/README.md index 814e9473c..1b952b5af 100644 --- a/dpdk_bindings/README.md +++ b/dpdk_bindings/README.md @@ -6,15 +6,28 @@ at https://aka.ms/demikernel. We have tested this crate on Windows and Linux. ## Prerequisites + - Install DPDK. +- Set the env. var CFLAGS to add include path to DPDK installation for header files. (-I) - Set the env. var LIBDPDK_PATH to point to the root of the DPDK installation. ## Related crates: + https://crates.io/search?q=demikernel We welcome comments and feedback. By sending feedback, you are consenting that it may be used in the further development of this project. +## Usage Statement + +This project is a prototype. As such, we provide no guarantees that it will +work and you are assuming any risks with using the code. We welcome comments +and feedback. Please send any questions or comments to one of the following +maintainers of the project: + +- [Irene Zhang](https://github.com/iyzhang) - [irene.zhang@microsoft.com](mailto:irene.zhang@microsoft.com) +- [Anand Bonde](https://github.com/anandbonde) - [abonde@microsoft.com](mailto:abonde@microsoft.com) + ## Trademark Notice This project may contain trademarks or logos for projects, products, or diff --git a/network_simulator/README.md b/network_simulator/README.md index 32fe96d52..92cdee968 100644 --- a/network_simulator/README.md +++ b/network_simulator/README.md @@ -6,11 +6,22 @@ at https://aka.ms/demikernel. We have tested this crate on Windows and Linux. ## Related crates + https://crates.io/search?q=demikernel We welcome comments and feedback. By sending feedback, you are consenting that it may be used in the further development of this project. +## Usage Statement + +This project is a prototype. As such, we provide no guarantees that it will +work and you are assuming any risks with using the code. We welcome comments +and feedback. Please send any questions or comments to one of the following +maintainers of the project: + +- [Irene Zhang](https://github.com/iyzhang) - [irene.zhang@microsoft.com](mailto:irene.zhang@microsoft.com) +- [Anand Bonde](https://github.com/anandbonde) - [abonde@microsoft.com](mailto:abonde@microsoft.com) + ## Trademark Notice This project may contain trademarks or logos for projects, products, or diff --git a/xdp_bindings/README.md b/xdp_bindings/README.md index e0f1089e1..a503bdc7e 100644 --- a/xdp_bindings/README.md +++ b/xdp_bindings/README.md @@ -6,15 +6,27 @@ at https://aka.ms/demikernel. We have tested this crate on Windows only. ## Prerequisites + - Install XDP dev kit for Windows. - Set the env. var XDP_PATH to point to the root of the XDP dev kit. ## Related crates + https://crates.io/search?q=demikernel We welcome comments and feedback. By sending feedback, you are consenting that it may be used in the further development of this project. +## Usage Statement + +This project is a prototype. As such, we provide no guarantees that it will +work and you are assuming any risks with using the code. We welcome comments +and feedback. Please send any questions or comments to one of the following +maintainers of the project: + +- [Irene Zhang](https://github.com/iyzhang) - [irene.zhang@microsoft.com](mailto:irene.zhang@microsoft.com) +- [Anand Bonde](https://github.com/anandbonde) - [abonde@microsoft.com](mailto:abonde@microsoft.com) + ## Trademark Notice This project may contain trademarks or logos for projects, products, or