logo + review doc

AUTHORS

@@ -8,3 +8,4 @@ Paolo Monteverde aka morbo84
 David Nerjes aka DavidHamburg
 Indi Kernick aka Kerndog73
 Malte Müller-Rowold aka m-waka
+Richard Caseres aka richardbmx

CMakeLists.txt

@@ -16,7 +16,7 @@ endif()
 # Project configuration
 #
 
-project(entt VERSION 2.7.1)
+project(EnTT VERSION 2.7.1)
 
 include(GNUInstallDirs)
 
@@ -34,7 +34,7 @@ message("* ${PROJECT_NAME} v${PROJECT_VERSION} (${CMAKE_BUILD_TYPE})")
 message("* Copyright (c) 2018 ${PROJECT_AUTHOR} <${PROJECT_AUTHOR_EMAIL}>")
 message("*")
 
-option(ENTT_COMPILE_OPTIONS "Use compile options from EnTT." ON)
+option(USE_COMPILE_OPTIONS "Use compile options from EnTT." ON)
 option(USE_LIBCPP "Use libc++ by adding -stdlib=libc++ flag if availbale." ON)
 
 #
@@ -79,7 +79,7 @@ target_compile_definitions(
     INTERFACE $<$<AND:$<CONFIG:Release>,$<NOT:$<CXX_COMPILER_ID:MSVC>>>:RELEASE>
 )
 
-if(ENTT_COMPILE_OPTIONS)
+if(USE_COMPILE_OPTIONS)
     target_compile_options(
         EnTT
         INTERFACE $<$<AND:$<CONFIG:Debug>,$<NOT:$<CXX_COMPILER_ID:MSVC>>>:-O0 -g>
@@ -101,20 +101,20 @@ target_compile_features(EnTT INTERFACE cxx_std_14)
 #
 
 if(${CMAKE_SYSTEM_NAME} STREQUAL "Windows")
-    set(ENTT_INSTALL_CONFIGDIR cmake)
+    set(CUSTOM_INSTALL_CONFIGDIR cmake)
 else()
-    set(ENTT_INSTALL_CONFIGDIR ${CMAKE_INSTALL_LIBDIR}/cmake/entt)
+    set(CUSTOM_INSTALL_CONFIGDIR ${CMAKE_INSTALL_LIBDIR}/cmake/entt)
 endif()
 
 install(DIRECTORY src/ DESTINATION ${CMAKE_INSTALL_INCLUDEDIR})
 install(TARGETS EnTT EXPORT EnTTTargets)
 
-export(EXPORT EnTTTargets FILE ${entt_BINARY_DIR}/EnTTTargets.cmake)
+export(EXPORT EnTTTargets FILE ${EnTT_BINARY_DIR}/EnTTTargets.cmake)
 
 install(
     EXPORT EnTTTargets
     FILE EnTTTargets.cmake
-    DESTINATION ${ENTT_INSTALL_CONFIGDIR}
+    DESTINATION ${CUSTOM_INSTALL_CONFIGDIR}
 )
 
 #
@@ -131,23 +131,23 @@ include(CMakePackageConfigHelpers)
 
 configure_package_config_file(
     cmake/in/EnTTConfig.cmake.in
-    ${ENTT_INSTALL_CONFIGDIR}/EnTTConfig.cmake
-    INSTALL_DESTINATION ${ENTT_INSTALL_CONFIGDIR}
+    ${CUSTOM_INSTALL_CONFIGDIR}/EnTTConfig.cmake
+    INSTALL_DESTINATION ${CUSTOM_INSTALL_CONFIGDIR}
     PATH_VARS CMAKE_INSTALL_INCLUDEDIR
     NO_CHECK_REQUIRED_COMPONENTS_MACRO
 )
 
 write_basic_package_version_file(
-    ${entt_BINARY_DIR}/EnTTConfigVersion.cmake
+    ${EnTT_BINARY_DIR}/EnTTConfigVersion.cmake
     VERSION ${PROJECT_VERSION}
     COMPATIBILITY AnyNewerVersion
 )
 
 install(
     FILES
-        ${entt_BINARY_DIR}/${ENTT_INSTALL_CONFIGDIR}/EnTTConfig.cmake
-        ${entt_BINARY_DIR}/EnTTConfigVersion.cmake
-    DESTINATION ${ENTT_INSTALL_CONFIGDIR}
+        ${EnTT_BINARY_DIR}/${CUSTOM_INSTALL_CONFIGDIR}/EnTTConfig.cmake
+        ${EnTT_BINARY_DIR}/EnTTConfigVersion.cmake
+    DESTINATION ${CUSTOM_INSTALL_CONFIGDIR}
 )
 
 export(PACKAGE EnTT)
@@ -168,8 +168,8 @@ if(BUILD_TESTING)
         find_package(GTest REQUIRED)
     else()
         # gtest, gtest_main, gmock and gmock_main targets are available from now on
-        set(GOOGLETEST_DEPS_DIR ${entt_SOURCE_DIR}/deps/googletest)
-        configure_file(${entt_SOURCE_DIR}/cmake/in/googletest.in ${GOOGLETEST_DEPS_DIR}/CMakeLists.txt)
+        set(GOOGLETEST_DEPS_DIR ${EnTT_SOURCE_DIR}/deps/googletest)
+        configure_file(${EnTT_SOURCE_DIR}/cmake/in/googletest.in ${GOOGLETEST_DEPS_DIR}/CMakeLists.txt)
         execute_process(COMMAND ${CMAKE_COMMAND} -G "${CMAKE_GENERATOR}" . WORKING_DIRECTORY ${GOOGLETEST_DEPS_DIR})
         execute_process(COMMAND ${CMAKE_COMMAND} --build . WORKING_DIRECTORY ${GOOGLETEST_DEPS_DIR})
         set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
@@ -208,9 +208,10 @@ add_custom_target(
     SOURCES
         appveyor.yml
         AUTHORS
-        CONTRIBUTING
         LICENSE
         README.md
         TODO
         .travis.yml
+        docs/CONTRIBUTING.md
+        docs/extra.dox
 )

README.md

@@ -1,5 +1,8 @@
-# EnTT
+![EnTT: Gaming meets modern C++](https://user-images.githubusercontent.com/1812216/42513718-ee6e98d0-8457-11e8-9baf-8d83f61a3097.png)
 
+<!--
+@cond TURN_OFF_DOXYGEN
+-->
 [![Build Status](https://travis-ci.org/skypjack/entt.svg?branch=master)](https://travis-ci.org/skypjack/entt)
 [![Build status](https://ci.appveyor.com/api/projects/status/rvhaabjmghg715ck?svg=true)](https://ci.appveyor.com/project/skypjack/entt)
 [![Coverage Status](https://coveralls.io/repos/github/skypjack/entt/badge.svg?branch=master)](https://coveralls.io/github/skypjack/entt?branch=master)
@@ -63,6 +66,9 @@
 * [Support](#support)
    * [Donation](#donation)
    * [Hire me](#hire-me)
+<!--
+@endcond TURN_OFF_DOXYGEN
+-->
 
 # Introduction
 
@@ -98,9 +104,7 @@ Here is a brief, yet incomplete list of what it offers today:
 * ...
 * Any other business.
 
-Consider it a work in progress. For more details and an updated list, please
-refer to the [online documentation](https://skypjack.github.io/entt/). It
-probably contains much more. Moreover, the whole API is fully documented in-code
+Consider it a work in progress. The whole API is also fully documented in-code
 for those who are brave enough to read it.
 
 Currently, `EnTT` is tested on Linux, Microsoft Windows and OS X. It has proven
@@ -320,8 +324,14 @@ The API reference will be created in HTML format within the directory
     $ cd build
     $ your_favorite_browser docs/html/index.html
 
+<!--
+@cond TURN_OFF_DOXYGEN
+-->
 The API reference is also available [online](https://skypjack.github.io/entt/)
 for the latest version.
+<!--
+@endcond TURN_OFF_DOXYGEN
+-->
 
 ## Tests
 
@@ -2768,6 +2778,9 @@ Below an incomplete list of projects and articles:
 If you know of other resources out there that are about `EnTT`, feel free to
 open an issue or a PR and I'll be glad to add them to the list.
 
+<!--
+@cond TURN_OFF_DOXYGEN
+-->
 # Contributors
 
 `EnTT` was written initially as a faster alternative to other well known and
@@ -2784,20 +2797,29 @@ I can't promise that each and every contribution will be accepted, but I can
 assure that I'll do my best to take them all seriously.
 
 If you decide to participate, please see the guidelines for
-[contributing](https://github.com/skypjack/entt/blob/master/CONTRIBUTING)
-before to create issues or pull requests.<br/>
+[contributing](docs/CONTRIBUTING.md) before to create issues or pull requests.<br/>
 Take also a look at the
 [contributors list](https://github.com/skypjack/entt/blob/master/AUTHORS) to
 know who has participated so far.
+<!--
+@endcond TURN_OFF_DOXYGEN
+-->
 
 # License
 
-Code and documentation Copyright (c) 2018 Michele Caini.<br/>
+Code and documentation Copyright (c) 2017-2018 Michele Caini.<br/>
+Logo Copyright (c) 2018 Richard Caseres.
+
 Code released under
 [the MIT license](https://github.com/skypjack/entt/blob/master/LICENSE).
-Docs released under
-[Creative Commons](https://github.com/skypjack/entt/blob/master/docs/LICENSE).
-
+Documentation released under
+[CC BY 4.0](https://creativecommons.org/licenses/by/4.0/).<br/>
+Logo released under
+[CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/).
+
+<!--
+@cond TURN_OFF_DOXYGEN
+-->
 # Support
 
 ## Donation
@@ -2818,3 +2840,6 @@ to give it the highest priority, if you have any other reason to contact me:
 do not hesitate. I'm available for hiring.<br/>
 Feel free to take a look at my [profile](https://github.com/skypjack) and
 contact me by mail.
+<!--
+@endcond TURN_OFF_DOXYGEN
+-->

docs/CMakeLists.txt

@@ -2,7 +2,7 @@
 # Doxygen configuration (documentation)
 #
 
-set(DOXY_SOURCE_DIRECTORY ${entt_SOURCE_DIR}/src)
+set(DOXY_SOURCE_DIRECTORY ${EnTT_SOURCE_DIR}/src)
 set(DOXY_DOCS_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR})
 set(DOXY_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR})
 
@@ -11,7 +11,7 @@ configure_file(doxy.in doxy.cfg @ONLY)
 add_custom_target(
     docs ALL
     COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/doxy.cfg
-    WORKING_DIRECTORY ${entt_SOURCE_DIR}
+    WORKING_DIRECTORY ${EnTT_SOURCE_DIR}
     VERBATIM
     SOURCES doxy.in
 )