diff --git a/CMakeLists.txt b/CMakeLists.txt index e8fb95c..1151cb0 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -176,7 +176,9 @@ ENDIF(ENABLE_NLS) # Project subdirectories. ADD_SUBDIRECTORY(extlib) ADD_SUBDIRECTORY(src) -ADD_SUBDIRECTORY(doc) +IF(INSTALL_DOC) + ADD_SUBDIRECTORY(doc) +ENDIF(INSTALL_DOC) # TODO: Print build summary indicating what plugins will be built. # (Some other project had something like this...) @@ -198,6 +200,16 @@ SET(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_SOURCE_DIR}/LICENSE") SET(CPACK_RESOURCE_FILE_README "${CMAKE_SOURCE_DIR}/README.md") #SET(CPACK_RESOURCE_FILE_WELCOME "${CMAKE_SOURCE_DIR}/doc/WELCOME.txt") +IF(INSTALL_DOC) + # Additional document files for the root directory. + # TODO: Convert from Unix line endings to Windows when + # compiling for Windows? + INCLUDE(DirInstallPaths) + INSTALL(FILES NETWORK.md + DESTINATION "${DIR_INSTALL_DOC_ROOT}" + COMPONENT "doc") +ENDIF(INSTALL_DOC) + # CPack: Source package settings. # NOTE: Double-escape is required because the unescaped # string # is written to CPackSourceConfig.cmake, which diff --git a/NETWORK.md b/NETWORK.md new file mode 100644 index 0000000..919b194 --- /dev/null +++ b/NETWORK.md @@ -0,0 +1,7 @@ +# Network Access Information + +rvthtool, and other programs included with rvthtool (qrvthtool, wadresign, +and nusresign) do not have any code to access any network services. + +If you use rvthtool (or other included programs) to access files on a network +share, it will use OS-provided facilities to access those files. diff --git a/cmake/options.cmake b/cmake/options.cmake index 1bfb11c..9619261 100644 --- a/cmake/options.cmake +++ b/cmake/options.cmake @@ -52,3 +52,6 @@ OPTION(ENABLE_NLS "Enable NLS using Qt's built-in localization system." ON) IF(CMAKE_SYSTEM_NAME STREQUAL "Linux") OPTION(ENABLE_NIXOS "Enable special handling for NixOS builds." OFF) ENDIF(CMAKE_SYSTEM_NAME STREQUAL "Linux") + +# Install documentation +OPTION(INSTALL_DOC "Install documentation." ON)