Merge pull request #131 from entity-toolkit/dev/installrule

Install rule for the executable

Author: haykh

CMakeLists.txt

@@ -7,7 +7,7 @@ set(PROJECT_NAME entity)
 
 project(
   ${PROJECT_NAME}
-  VERSION 1.2.0
+  VERSION 1.2.1
   LANGUAGES CXX C)
 add_compile_options("-D ENTITY_VERSION=\"${PROJECT_VERSION}\"")
 set(hash_cmd "git diff --quiet src/ && echo $(git rev-parse HEAD) ")

README.md

@@ -12,21 +12,23 @@ Our [detailed documentation](https://entity-toolkit.github.io/) includes everyth
 
 ## Join the community
 
-Everyone is welcome to join our small yet steadily growing community of code users and developers; regardless of how much you are planning to contribute -- we always welcome fresh ideas and feedback. We hold weekly Zoom meetings on Mondays at 12pm NY time, and have a dedicated Slack channel where you can be easily added by [emailing](mailto:haykh.astro@gmail.com) [one of the maintainers](mailto:genegorbs@gmail.com). If you prefer to just join our Zoom meetings without the Slack involvement -- that's totally fine, just email, and we can send you the Zoom link. 
+Everyone is welcome to join our small yet steadily growing community of code users and developers; regardless of how much you are planning to contribute -- we always welcome fresh ideas and feedback. We hold weekly Slack calls on Mondays at 12pm NY time, and have a dedicated Slack channel where you can be easily added by emailing one of the maintainers (indicated with an asterisk in the list below). Anyone is welcome to join both our **Slack workspace** and the weekly meetings -- please feel free to request access by emailing.
 
 Another way of contacting us is via GitHub issues and/or pull requests. Make sure to check out our [F.A.Q.](https://entity-toolkit.github.io/wiki/content/1-getting-started/9-faq/), as it might help you answer your question.
 
 > Keep in mind, you are free to use the code in any capacity, and there is absolutely no requirement on our end of including any of the developers in your project/proposal (as highlighted in our Code of Conduct). When contributing, also keep in mind that the code you upload to the repository automatically becomes public and open-source, and the same standards will be applied to it as to the rest of the code. 
 
 ## Contributors (alphabetical)
 
+Maintainers indicated with an arrow.
+
 * :guitar: Ludwig Böss {[@LudwigBoess](https://github.com/LudwigBoess)}
 * :eyes: Yangyang Cai {[@StaticObserver](https://github.com/StaticObserver)}
 * :tipping_hand_person: Alexander Chernoglazov {[@SChernoglazov](https://github.com/SChernoglazov)}
 * :tea: Benjamin Crinquand {[@bcrinquand](https://github.com/bcrinquand)}
 * :bubble_tea: Alisa Galishnikova {[@alisagk](https://github.com/alisagk)}
-* :steam_locomotive: Evgeny Gorbunov {[@Alcauchy](https://github.com/Alcauchy)}
-* :coffee: Hayk Hakobyan {[@haykh](https://github.com/haykh)}
+* :steam_locomotive: Evgeny Gorbunov {[@Alcauchy](https://github.com/Alcauchy)} [-> [haykh.astro [at] gmail](mailto:haykh.astro@gmail.com)]
+* :coffee: Hayk Hakobyan {[@haykh](https://github.com/haykh)} [-> [genegorbs [at] gmail](mailto:genegorbs@gmail.com)]
 * :potato: Jens Mahlmann {[@jmahlmann](https://github.com/jmahlmann)}
 * :dolphin: Sasha Philippov {[@sashaph](https://github.com/sashaph)}
 * :radio: Siddhant Solanki {[@sidruns30](https://github.com/sidruns30)}

cmake/report.cmake

@@ -142,6 +142,9 @@ string(
   "  "
   ${DEBUG_REPORT}
   "\n"
+  "  - Install prefix [${Magenta}CMAKE_INSTALL_PREFIX${ColorReset}]:    "
+  "${CMAKE_INSTALL_PREFIX}"
+  "\n"
   ${DASHED_LINE_SYMBOL}
   "\n"
   "Compilers & dependencies"
@@ -222,7 +225,12 @@ string(
   "${Magenta}<FLAG>${ColorReset}${Dim}=<VALUE>`, "
   "the ${Underline}default${ColorReset}${Dim} value"
   "\n"
-  "    :   will be used unless the variable is explicitly set.${ColorReset}")
+  "    :   will be used unless the variable is explicitly set.${ColorReset}"
+  "\n"
+  "    ${Dim}: When running `cmake --install <BUILD_DIR>`,"
+  " \n"
+  "    :   the executable is copied to "
+  "`${Magenta}<CMAKE_INSTALL_PREFIX>${ColorReset}${Dim}/bin`.${ColorReset}")
 
 if(${TESTS})
   string(

src/CMakeLists.txt

@@ -44,3 +44,4 @@ add_executable(${ENTITY} ${SOURCES})
 set(libs ntt_global ntt_framework ntt_metrics ntt_engines ntt_pgen)
 add_dependencies(${ENTITY} ${libs})
 target_link_libraries(${ENTITY} PUBLIC ${libs})
+install(TARGETS ${ENTITY} DESTINATION bin)