includes requirements in readme

jjzhang166 · Apr 7, 2015 · dd46ff3 · dd46ff3
1 parent 1036054
commit dd46ff3
Showing 1 changed file with 9 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -7,7 +7,15 @@ evaluation wherever possible.
 
 *Note*: Everthing is inside the `iter` namespace.
 
-##### Table of Contents
+#### Requirements
+This library is **header-only** and relies only on the C++ standard
+library. The only exception is `zip_longest` which uses `boost::optional`.
+`#include <cppitertools/itertools.hpp>` will include all of the provided
+tools except for `zip_longest` which must be included separately.  You may
+also include individual pieces with the relevant header
+(`#include <cppitertools/enumerate.hpp>` for example).
+
+#### Table of Contents
 [range](#range)<br />
 [enumerate](#enumerate)<br />
 [zip](#zip)<br />