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 <stephen@networkplumber.org>
Acked-by: John McNamara <john.mcnamara@intel.com>

diff --git a/MAINTAINERS b/MAINTAINERS
index c151117..b90aeea 100644 (file)
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -39,6 +39,7 @@ Documentation (with overlaps)
 -------------
 M: Siobhan Butler <siobhan.a.butler@intel.com>
 M: John McNamara <john.mcnamara@intel.com>
+F: README
 F: doc/
 
 

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..29ba0e0
--- /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