From: Daniel Wagner <dwagner@suse.de>
Date: Tue, 8 Feb 2022 15:30:41 +0000 (+0100)
Subject: README: Mention meson subprojects update
X-Git-Tag: v2.0-rc5~2^2
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=d1438a5c692ee6bf967cf6b16bf7b33d646a6ab5;p=users%2Fsagi%2Fnvme-cli.git

README: Mention meson subprojects update

New meson users are not aware of this rather nifty update
mechanism. Mention it in the README.

While at it also mention the library dependency.

Signed-off-by: Daniel Wagner <dwagner@suse.de>
---

diff --git a/README.md b/README.md
index 2663869a..f8aa9a13 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,8 @@ run following commands
 	$ meson .build
 	$ ninja -C .build
 
+nvme-cli depends on zlib, json-c and libuuid.
+
 To install, run:
 
 	# meson install -C .build
@@ -236,3 +238,15 @@ File: foo-plugin.c
 
 After that, you just need to implement the functions you defined in each
 ENTRY, then append the object file name to the meson.build "sources".
+
+## meson tips
+
+In case meson doesn't find libnvme header files (via pkg-config) it
+will fallback using subprojects. meson checks out libnvme in
+subprojects directory as git tree once and will not modify libnvme
+unless explicitly told. That means the current branch is updated via
+git, the subprojects/libnvme branch will not updated accordingly. So
+either update it via normal git operations or
+
+    $ meson subprojects update
+