Skip to content

Commit 8185779

Browse files
committed
Added AUTHORS, CHANGES, LICENSE and CONTRIBUTING.md files to installer package. Text files without extensions are packaged with 'txt' file extension.
For issue #75
1 parent 270c48e commit 8185779

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@
33
/third_parties
44
/README.html
55
/UserManual.html
6+
/CONTRIBUTING.html

CMakeLists.txt

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,7 @@ endif()
186186
# Set the default filenames to be published with the install/package.
187187
set (README_FILENAME README.md)
188188
set (USERMANUAL_FILENAME UserManual.md)
189+
set (CONTRIBUTING_FILENAME CONTRIBUTING.md)
189190

190191
if (GRIP_FOUND)
191192
# Convert README.md
@@ -203,10 +204,35 @@ if (GRIP_FOUND)
203204
else()
204205
message(FATAL_ERROR "grip failed converting UserManual.md with res_var='${res_var}'")
205206
endif()
207+
208+
# Convert CONTRIBUTING.md
209+
execute_process(COMMAND grip CONTRIBUTING.md --export CONTRIBUTING.html --user-content --context=end2endzone/ShellAnything RESULT_VARIABLE res_var WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR})
210+
if("${res_var}" STREQUAL "0")
211+
set (CONTRIBUTING_FILENAME CONTRIBUTING.html)
212+
else()
213+
message(FATAL_ERROR "grip failed converting CONTRIBUTING.md with res_var='${res_var}'")
214+
endif()
206215
else()
207216
message(WARNING "grip is not found on the system. grip is required for publishing markdown files to html. Files will be published as *.md files.")
208217
endif()
209218

219+
# AUTHORS.txt
220+
set(SHELLANYTHING_AUTHOR_TXT ${CMAKE_BINARY_DIR}/AUTHORS.txt)
221+
message("Generating ${SHELLANYTHING_AUTHOR_TXT}...")
222+
configure_file( ${CMAKE_SOURCE_DIR}/AUTHORS ${SHELLANYTHING_AUTHOR_TXT} )
223+
get_filename_component(AUTHOR_FILENAME ${SHELLANYTHING_AUTHOR_TXT} NAME)
224+
225+
# CHANGES.txt
226+
set(SHELLANYTHING_CHANGES_TXT ${CMAKE_BINARY_DIR}/CHANGES.txt)
227+
message("Generating ${SHELLANYTHING_CHANGES_TXT}...")
228+
configure_file( ${CMAKE_SOURCE_DIR}/CHANGES ${SHELLANYTHING_CHANGES_TXT} )
229+
get_filename_component(CHANGES_FILENAME ${SHELLANYTHING_CHANGES_TXT} NAME)
230+
231+
# LICENSE.txt
232+
set(SHELLANYTHING_LICENSE_TXT ${CMAKE_BINARY_DIR}/LICENSE.txt)
233+
message("Generating ${SHELLANYTHING_LICENSE_TXT}...")
234+
configure_file( ${CMAKE_SOURCE_DIR}/LICENSE ${SHELLANYTHING_LICENSE_TXT} )
235+
get_filename_component(LICENSE_FILENAME ${SHELLANYTHING_LICENSE_TXT} NAME)
210236

211237
##############################################################################################################################################
212238
# Install
@@ -245,6 +271,11 @@ install(FILES ${CMAKE_SOURCE_DIR}/README.md
245271
${CMAKE_SOURCE_DIR}/UserManual.md
246272
${CMAKE_SOURCE_DIR}/${README_FILENAME}
247273
${CMAKE_SOURCE_DIR}/${USERMANUAL_FILENAME}
274+
${CMAKE_SOURCE_DIR}/CONTRIBUTING.md
275+
${CMAKE_SOURCE_DIR}/${CONTRIBUTING_FILENAME}
276+
${CMAKE_BINARY_DIR}/${AUTHOR_FILENAME}
277+
${CMAKE_BINARY_DIR}/${CHANGES_FILENAME}
278+
${CMAKE_BINARY_DIR}/${LICENSE_FILENAME}
248279
DESTINATION ${SHELLANYTHING_INSTALL_ROOT_DIR})
249280

250281
##############################################################################################################################################
@@ -303,6 +334,10 @@ set(CPACK_PACKAGE_EXECUTABLES
303334
set(CPACK_NSIS_MENU_LINKS
304335
"${README_FILENAME}" "${README_FILENAME}"
305336
"${USERMANUAL_FILENAME}" "${USERMANUAL_FILENAME}"
337+
"${CONTRIBUTING_FILENAME}" "${CONTRIBUTING_FILENAME}"
338+
"${AUTHOR_FILENAME}" "${AUTHOR_FILENAME}"
339+
"${CHANGES_FILENAME}" "${CHANGES_FILENAME}"
340+
"${LICENSE_FILENAME}" "${LICENSE_FILENAME}"
306341
"licenses" "Third party licenses"
307342
"https://github.com/end2endzone/ShellAnything" "ShellAnything Web Site"
308343
"bin/register.bat" "Register shell extension"
@@ -331,6 +366,10 @@ set(CPACK_WIX_HELP_LINK "https://github.com/end2endzone/ShellAnything")
331366
set_property(INSTALL "bin/$<TARGET_FILE_NAME:shellext>" PROPERTY CPACK_START_MENU_SHORTCUTS "Run Unit Tests" )
332367
set_property(INSTALL "${README_FILENAME}" PROPERTY CPACK_START_MENU_SHORTCUTS "${README_FILENAME}" )
333368
set_property(INSTALL "${USERMANUAL_FILENAME}" PROPERTY CPACK_START_MENU_SHORTCUTS "${USERMANUAL_FILENAME}" )
369+
set_property(INSTALL "${CONTRIBUTING_FILENAME}" PROPERTY CPACK_START_MENU_SHORTCUTS "${CONTRIBUTING_FILENAME}" )
370+
set_property(INSTALL "${AUTHOR_FILENAME}" PROPERTY CPACK_START_MENU_SHORTCUTS "${AUTHOR_FILENAME}" )
371+
set_property(INSTALL "${CHANGES_FILENAME}" PROPERTY CPACK_START_MENU_SHORTCUTS "${CHANGES_FILENAME}" )
372+
set_property(INSTALL "${LICENSE_FILENAME}" PROPERTY CPACK_START_MENU_SHORTCUTS "${LICENSE_FILENAME}" )
334373
set_property(INSTALL "./licenses" PROPERTY CPACK_START_MENU_SHORTCUTS "Third party licenses" ) # This one does not work!
335374
set_property(INSTALL "https://github.com/end2endzone/ShellAnything" PROPERTY CPACK_START_MENU_SHORTCUTS "ShellAnything Web Site" )
336375
set_property(INSTALL "bin/register.bat" PROPERTY CPACK_START_MENU_SHORTCUTS "Register shell extension" )

0 commit comments

Comments
 (0)