From: Keith Busch <kbusch@kernel.org>
Date: Mon, 23 Aug 2021 16:23:59 +0000 (-0700)
Subject: update readme to indicate libnvme submodule
X-Git-Tag: v2.0-rc0~100
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=4d752d74061e7c508da3dfbc5be550c2ec1cfd55;p=users%2Fsagi%2Fnvme-cli.git

update readme to indicate libnvme submodule

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

diff --git a/README.md b/README.md
index bb0219e0..e9398518 100644
--- 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