update readme to indicate libnvme submodule

Signed-off-by: Keith Busch <kbusch@kernel.org>

diff --git a/README.md b/README.md
index bb0219e056afe852561a19ec5e6ce0115a8d5846..e9398518c03521fa4cd90c74ccb809f405e5d631 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,20 @@
 # nvme-cli
 NVM-Express user space tooling for Linux.
 
+When cloning from source, you will need the libnvme submodule, so use:
+
+    $ git clone --recurse-submodules https://github.com/linux-nvme/nvme-cli
+
+If you already cloned without recursing submodules, you will need to initialize
+and update it:
+
+    $ git submodule init --update
+
+Or as two commands:
+
+    $ git submodule init
+    $ git submodule update
+
 To install, run:
 
     $ make