Mention headers-only branch in README.md

banditcpp · Dec 5, 2017 · 98c8d81 · 98c8d81
1 parent 8e6a2bd
commit 98c8d81
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -8,6 +8,14 @@ An assertion library for C++
 
 Snowhouse is a stand-alone assertion framework for C++.
 
+It is a header-only library.
+You can simply use the `headers-only` branch as a submodule:
+
+```sh
+git submodule add -b headers-only https://github.com/banditcpp/snowhouse snowhouse
+git submodule update --init --recursive
+```
+
 ## Usage
 
 ```C++