diff --git a/README.md b/README.md index fcc8e0f..be1a51d 100644 --- a/README.md +++ b/README.md @@ -33,10 +33,14 @@ See the [project page][project] for full documentation. [enforce]: http://aantron.github.io/better-enums/demo/SpecialValues.html [project]: http://aantron.github.io/better-enums +
+ ## Installation Simply add `enum.h` to your project. +
+ ## Additional features - Uses only standard C++, though, for C++98, variadic macro support is required @@ -53,6 +57,8 @@ Simply add `enum.h` to your project. [testing]: http://aantron.github.io/better-enums/CompilerSupport.html [performance]: http://aantron.github.io/better-enums/Performance.html +
+ ## Limitations The biggest limitation is that the `BETTER_ENUM` macro can't be used inside a @@ -87,6 +93,8 @@ channel == +Channel::Red [nested]: http://aantron.github.io/better-enums/DesignDecisionsFAQ.html#NoEnumInsideClass [extend]: http://aantron.github.io/better-enums/ExtendingLimits.html +
+ ## Contact and development Don't hesitate to contact me about features or bugs: @@ -99,6 +107,8 @@ that both compiles quickly and allows lookup in sub-linear time. [email]: mailto:antonbachin@yahoo.com [contributing]: https://github.com/aantron/better-enums/blob/master/doc/CONTRIBUTING.md +
+ ## License and history Better Enums is released under the BSD 2-clause license. See