Merge pull request google#167 from ajdavis/patch-1

Tell users to install protoc
adamj-codethink · Jun 10, 2019 · 3a600c6 · 3a600c6
2 parents 6ae4a2c + 2b43176
commit 3a600c6
Showing 1 changed file with 7 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -26,8 +26,13 @@ This is not an official Google product.
 
 ## Building Bloaty
 
-Bloaty uses CMake to build.  All dependencies are included as Git submodules.
-To build, simply run:
+Building Bloaty requires CMake and ``protoc``, the protobuf compiler. On Ubuntu, install them with:
+
+```
+$ sudo apt install cmake protobuf-compiler
+```
+
+Bloaty bundles ``libprotobuf``, ``re2``, ``capstone``, and ``pkg-config`` as Git submodules, but it will prefer the system's versions of those dependencies if available. All other dependencies are included as Git submodules. To build, run:
 
 ```
 $ cmake .