diff --git a/samples/CMakeLists.txt b/samples/CMakeLists.txt index 8628a997d..f9169f8cc 100644 --- a/samples/CMakeLists.txt +++ b/samples/CMakeLists.txt @@ -3,7 +3,7 @@ set (SAMPLE_FILES JT9/130418_1742.wav ) -#set_directory_properties (PROPERTIES EXCLUDE_FROM_ALL ON) +set_directory_properties (PROPERTIES EXCLUDE_FROM_ALL ON) set (contents_file_ ${CMAKE_CURRENT_BINARY_DIR}/contents_${WSJTX_VERSION_MAJOR}.${WSJTX_VERSION_MINOR}.json) diff --git a/samples/README b/samples/README new file mode 100644 index 000000000..db1c18e55 --- /dev/null +++ b/samples/README @@ -0,0 +1,20 @@ +This directory contains the resources necessary to build the WSJT-X +samples database. The CMake build script creates a directory structure +ready for upload to the project samples web or ftp file server. The +CMake script also defines a build target 'upload-samples' which +uploads the sample database to the the destination defined by the +project CMake variable PROJECT_SAMPLES_UPLOAD_DEST (defined in the +project root CMake script). A suitably authorized user may use this +target to update the server with the latest samples. + +The samples database includes a JSON contents file for each +major/minor version combination of WSJT-X, this file is generated by +CMake and should not be manually edited. + +To add new samples simply add the files here and update the +SAMPLE_FILES list variable in the CMakeLists.txt file in this +directory. Sample files must be checked into source control. A +meaningful directory structure is advisable, the same directory +structure will be replicated by the WSJT-X sample downloader dialog +allowing WSJT-X users to easily identify wath each sample file +contains.