Update readme and value.h examples

braxtons12 · Jan 31, 2024 · cb01ee9 · cb01ee9
1 parent 3ed9107
commit cb01ee9
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -19,7 +19,16 @@ After following the Quick Start Guide, you'll be able to use hyperion::mpl in yo
 A basic example of what you can do with hyperion::mpl is below:
 
 ```cpp
-#include <hyperion/mpl/list.h>
+#include <hyperion/mpl/value.h>
+
+using namespace hyperion::mpl;
+
+constexpr auto val1 = Value<4>{};
+constexpr auto val2 = Value<2>{};
+
+constexpr auto meaning_of_life = (val1 * 10_value) + val2;
+
+static_assert(meaning_of_life == 42);
 ```
 
 ### Contributing

diff --git a/include/hyperion/mpl/value.h b/include/hyperion/mpl/value.h
@@ -58,6 +58,8 @@ HYPERION_IGNORE_DOCUMENTATION_WARNING_START;
 /// constexpr auto val2 = Value<2>{};
 ///
 /// constexpr auto meaning_of_life = (val1 * 10_value) + val2;
+///
+/// static_assert(meaning_of_life == 42);
 /// @endcode
 /// @headerfile hyperion/mpl/type_traits.h
 /// @}