]> www.infradead.org Git - users/sagi/libnvme.git/commitdiff
Add README
authorKeith Busch <kbusch@kernel.org>
Fri, 7 Feb 2020 04:08:39 +0000 (20:08 -0800)
committerKeith Busch <kbusch@kernel.org>
Fri, 7 Feb 2020 04:08:39 +0000 (20:08 -0800)
Signed-off-by: Keith Busch <kbusch@kernel.org>
README [new file with mode: 0644]

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..e54c8e8
--- /dev/null
+++ b/README
@@ -0,0 +1,26 @@
+libnvme
+-------
+
+This is the libnvme development C library. libnvme provides type
+defintions for NVMe specification structures, enumerations, and bit
+fields, helper functions to construct, dispatch, and decode commands
+and payloads, and utilities to connect, scan, and manage nvme devices
+on a Linux system.
+
+The public specification is the authority to resolve any protocol
+discrepencies with this library. For more info on NVM Express, please see:
+
+  http://nvmexpress.org
+
+Subscribe to linux-nvme@lists.infradead.org for linux-nvme related discussions
+and development for both kernel and userspace. The list is archived here:
+
+  http://lists.infradead.org/mailman/listinfo/linux-nvme
+
+License
+-------
+
+All software contained within this repo is currently licensed LGPL, see
+COPYING for more information.
+
+Keith Busch 2020-02-06