From c6dcefe4201ea67ebae56301a3e926f6ece72a7e Mon Sep 17 00:00:00 2001 From: Stephen Hemminger Date: Tue, 1 Dec 2015 20:20:05 -0800 Subject: [PATCH] doc: add readme file This project is missing a proper README which is used in other projects and some git visualization services. Only a starting point, please feel free to edit. To keep the file short and current, I avoided putting any specific information about features and versions. Signed-off-by: Stephen Hemminger Acked-by: John McNamara --- MAINTAINERS | 1 + README | 11 +++++++++++ 2 files changed, 12 insertions(+) create mode 100644 README diff --git a/MAINTAINERS b/MAINTAINERS index c1511173c2..b90aeea76e 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -39,6 +39,7 @@ Documentation (with overlaps) ------------- M: Siobhan Butler M: John McNamara +F: README F: doc/ diff --git a/README b/README new file mode 100644 index 0000000000..29ba0e0e33 --- /dev/null +++ b/README @@ -0,0 +1,11 @@ +DPDK is a set of libraries and drivers for fast packet processing. +It supports many processor architectures and both FreeBSD and Linux. + +The DPDK uses the Open Source BSD license for the core libraries and +drivers. The kernel components are GPLv2 licensed. + +Please check the doc directory for release notes, +API documentation, and sample application information. + +For questions and usage discussions, subscribe to: users@dpdk.org +Report bugs and issues to the development mailing list: dev@dpdk.org -- 2.20.1