Skip to content

Commit

Permalink
Merge pull request #1499 from microsoft/ab-crates-readme-disclaimers
Browse files Browse the repository at this point in the history
[demikernel] Enhancement: update crates docs
  • Loading branch information
anandbonde authored Feb 7, 2025
2 parents 4de64d5 + 917fbca commit e6c39ef
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 1 deletion.
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@ maintainers of the project:

- [Irene Zhang](https://github.com/iyzhang) - [[email protected]](mailto:[email protected])
- [Anand Bonde](https://github.com/anandbonde) - [[email protected]](mailto:[email protected])
- [Pedro Henrique Penna](https://github.com/ppenna) - [[email protected]](mailto:[email protected])

> By sending feedback, you are consenting that it may be used in the further
> development of this project.
Expand Down
13 changes: 13 additions & 0 deletions dpdk_bindings/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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<path_to_dpdk_headers>)
- 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) - [[email protected]](mailto:[email protected])
- [Anand Bonde](https://github.com/anandbonde) - [[email protected]](mailto:[email protected])

## Trademark Notice

This project may contain trademarks or logos for projects, products, or
Expand Down
11 changes: 11 additions & 0 deletions network_simulator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) - [[email protected]](mailto:[email protected])
- [Anand Bonde](https://github.com/anandbonde) - [[email protected]](mailto:[email protected])

## Trademark Notice

This project may contain trademarks or logos for projects, products, or
Expand Down
12 changes: 12 additions & 0 deletions xdp_bindings/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) - [[email protected]](mailto:[email protected])
- [Anand Bonde](https://github.com/anandbonde) - [[email protected]](mailto:[email protected])

## Trademark Notice

This project may contain trademarks or logos for projects, products, or
Expand Down

0 comments on commit e6c39ef

Please sign in to comment.