Some helpful developer documentation

git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@6310 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
This commit is contained in:
Bill Somerville 2015-12-24 13:19:54 +00:00
parent 8efde1b4ef
commit b98b4ae299
2 changed files with 21 additions and 1 deletions

View File

@ -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)

20
samples/README Normal file
View File

@ -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.