Documentation nits.

This commit is contained in:
Anton Bachin 2016-02-27 14:06:22 -06:00
parent cc9cce28ae
commit a500851e28
3 changed files with 30 additions and 34 deletions

View File

@ -1,15 +1,22 @@
# Better Enums # Better Enums   [![version 0.11.0][version]][releases] [![Try online][wandbox-img]][wandbox] [![Travis status][travis-img]][travis] [![AppVeyor status][appveyor-img]][appveyor] [![BSD license][license-img]][license]
[version]: https://img.shields.io/badge/version-0.11.0-blue.svg
[releases]: https://github.com/aantron/better-enums/releases
[wandbox]: http://melpon.org/wandbox/permlink/2QCi3cwQnplAToge
[wandbox-img]: https://img.shields.io/badge/try%20it-online-blue.svg
[appveyor]: https://ci.appveyor.com/project/aantron/better-enums/branch/master
[travis]: https://travis-ci.org/aantron/better-enums/branches
[travis-img]: https://img.shields.io/travis/aantron/better-enums/master.svg?label=travis
[appveyor-img]: https://img.shields.io/appveyor/ci/aantron/better-enums/master.svg?label=appveyor
[license-img]: https://img.shields.io/badge/license-BSD-lightgrey.svg
Reflective compile-time enum library with clean syntax, in a single header Reflective compile-time enum library with clean syntax, in a single header
file and without dependencies. file, and without dependencies.
![Better Enums code overview][sample] ![Better Enums code overview][sample]
[sample]: https://raw.githubusercontent.com/aantron/better-enums/master/doc/image/sample.gif [sample]: https://raw.githubusercontent.com/aantron/better-enums/master/doc/image/sample.gif
[![Try online][wandbox-img]][wandbox] [![version 0.11.0][version]][releases]
[![BSD license][license-img]][license]
In C++11, *everything* can be used at compile time. You can convert your enums, In C++11, *everything* can be used at compile time. You can convert your enums,
loop over them, [find their max][max], loop over them, [find their max][max],
[statically enforce conventions][enforce], and pass along the results as [statically enforce conventions][enforce], and pass along the results as
@ -25,14 +32,6 @@ See the [project page][project] for full documentation.
[max]: http://aantron.github.io/better-enums/demo/BitSets.html [max]: http://aantron.github.io/better-enums/demo/BitSets.html
[enforce]: http://aantron.github.io/better-enums/demo/SpecialValues.html [enforce]: http://aantron.github.io/better-enums/demo/SpecialValues.html
[project]: http://aantron.github.io/better-enums [project]: http://aantron.github.io/better-enums
[wandbox]: http://melpon.org/wandbox/permlink/2QCi3cwQnplAToge
[tutorial]: http://aantron.github.io/better-enums#Tutorial
[api]: http://aantron.github.io/better-enums/ApiReference.html
[releases]: https://github.com/aantron/better-enums/releases
[wandbox-img]: https://img.shields.io/badge/try%20it-online-blue.svg
[version]: https://img.shields.io/badge/version-0.11.0-lightgrey.svg
[license-img]: https://img.shields.io/badge/license-BSD-lightgrey.svg
## Installation ## Installation
@ -97,19 +96,11 @@ Don't hesitate to contact me about features or bugs:
[antonbachin@yahoo.com][email], or open an issue on GitHub. [antonbachin@yahoo.com][email], or open an issue on GitHub.
If you'd like to help develop Better Enums, see [CONTRIBUTING][contributing]. If you'd like to help develop Better Enums, see [CONTRIBUTING][contributing].
One area that could use fresh ideas is finding a compile-time data structure
[![master kept stable][stable]][commits] [![Travis status][travis-img]][travis] that both compiles quickly and allows lookup in sub-linear time.
[![AppVeyor status][appveyor-img]][appveyor]
[email]: mailto:antonbachin@yahoo.com [email]: mailto:antonbachin@yahoo.com
[contributing]: https://github.com/aantron/better-enums/blob/master/doc/CONTRIBUTING.md [contributing]: https://github.com/aantron/better-enums/blob/master/doc/CONTRIBUTING.md
[stable]: https://img.shields.io/badge/master-kept_stable-brightgreen.svg
[commits]: https://github.com/aantron/better-enums/blob/master/doc/CONTRIBUTING.md#commits
[appveyor]: https://ci.appveyor.com/project/aantron/better-enums/branch/master
[travis]: https://travis-ci.org/aantron/better-enums/branches
[travis-img]: https://img.shields.io/travis/aantron/better-enums/master.svg?label=travis
[appveyor-img]: https://img.shields.io/appveyor/ci/aantron/better-enums/master.svg?label=appveyor
## License and history ## License and history

View File

@ -2,9 +2,9 @@
Better Enums aims to support all major compilers. It is known to work on: Better Enums aims to support all major compilers. It is known to work on:
- clang 3.3 to 3.7 - clang 3.3 to 3.9
- gcc 4.3 to 5.2 - gcc 4.3 to 5.3
- Visual C++ 2008 to 2015RC. - Visual C++ 2008 to 2015.
The library can be used with any compiler that supports either $cxx11, or $cxx98 The library can be used with any compiler that supports either $cxx11, or $cxx98
with the `__VA_ARGS__` extension. This includes every version of gcc and clang I with the `__VA_ARGS__` extension. This includes every version of gcc and clang I
@ -78,6 +78,14 @@ vc2013 /EHsc /DBETTER_ENUMS_STRICT_CONVERSION
vc2012 /EHsc vc2012 /EHsc
vc2010 /EHsc vc2010 /EHsc
vc2008 /EHsc vc2008 /EHsc
clang++39 -std=c++11
clang++39 -std=c++11 -DBETTER_ENUMS_STRICT_CONVERSION
clang++39 -std=c++11 -DBETTER_ENUMS_CONSTEXPR_TO_STRING
clang++39 -std=c++98
clang++38 -std=c++11
clang++38 -std=c++11 -DBETTER_ENUMS_STRICT_CONVERSION
clang++38 -std=c++11 -DBETTER_ENUMS_CONSTEXPR_TO_STRING
clang++38 -std=c++98
clang++37 -std=c++11 clang++37 -std=c++11
clang++37 -std=c++11 -DBETTER_ENUMS_STRICT_CONVERSION clang++37 -std=c++11 -DBETTER_ENUMS_STRICT_CONVERSION
clang++37 -std=c++11 -DBETTER_ENUMS_CONSTEXPR_TO_STRING clang++37 -std=c++11 -DBETTER_ENUMS_CONSTEXPR_TO_STRING
@ -95,10 +103,10 @@ clang++34 -std=c++11 -DBETTER_ENUMS_STRICT_CONVERSION
clang++34 -std=c++11 -DBETTER_ENUMS_CONSTEXPR_TO_STRING clang++34 -std=c++11 -DBETTER_ENUMS_CONSTEXPR_TO_STRING
clang++34 -std=c++98 clang++34 -std=c++98
clang++33 -std=c++98 clang++33 -std=c++98
g++52 -std=c++11 g++53 -std=c++11
g++52 -std=c++11 -DBETTER_ENUMS_STRICT_CONVERSION g++53 -std=c++11 -DBETTER_ENUMS_STRICT_CONVERSION
g++52 -std=c++11 -DBETTER_ENUMS_CONSTEXPR_TO_STRING g++53 -std=c++11 -DBETTER_ENUMS_CONSTEXPR_TO_STRING
g++52 -std=c++98 g++53 -std=c++98
g++49 -std=c++11 g++49 -std=c++11
g++49 -std=c++11 -DBETTER_ENUMS_STRICT_CONVERSION g++49 -std=c++11 -DBETTER_ENUMS_STRICT_CONVERSION
g++49 -std=c++11 -DBETTER_ENUMS_CONSTEXPR_TO_STRING g++49 -std=c++11 -DBETTER_ENUMS_CONSTEXPR_TO_STRING

View File

@ -1,18 +1,15 @@
## Contact ## Contact
- Send me an email: [antonbachin@yahoo.com](mailto:antonbachin@yahoo.com). - Send me an email: [antonbachin@yahoo.com](mailto:antonbachin@yahoo.com).
- Twitter: [@better_enums](https://twitter.com/better_enums).
- Visit the [GitHub]($repo) project to open an issue or get a development - Visit the [GitHub]($repo) project to open an issue or get a development
version. version.
I also watch the `enums` tag on Stack Overflow.
I'm happy to hear any feedback. If you have any trouble using the library or I'm happy to hear any feedback. If you have any trouble using the library or
parsing the documentation, please don't hesitate to let me know. I'd also be parsing the documentation, please don't hesitate to let me know. I'd also be
interested to hear about your use case, if you are willing to share :) interested to hear about your use case, if you are willing to share :)
And, if you find this library helpful, give it a star on GitHub to let me know And, if you find this library helpful, give it a star on GitHub to let me know
you use it. It will help keep me encouraged :) you use it :)
%% description = %% description =
Contact information for Better Enums bugs, issues, support, and feedback. Contact information for Better Enums bugs, issues, support, and feedback.