Add Caveats section to README.rst

The only caveat it currently has is regarding Windows and min/max macros.
ikalnytskyi · Feb 6, 2021 · fab28c5 · fab28c5
1 parent b0c5ee1
commit fab28c5
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -154,3 +154,11 @@ Control manipulators
 
 #. ``termcolor::colorize``
 #. ``termcolor::nocolorize``
+
+
+Caveats
+-------
+
+#. On Windows, due to internal usage of ``<windows.h>``, global namespace could
+   be polluted with `min`/`max` macros. If such effect is desireable, please
+   consider using ``#define NOMINMAX`` before ``#include <termcolor.hpp>``.