Updated manual for wordlists
[sgc2.git] / addons / README.txt
blobd4de524d3654a0575b28b9bb4ad0ed1891a1c6ee
1 Distribution of SpeakGoodChinese2 application and wordlists
3 Wordlists and/or SpeakGoodChinese binaries are installed when executing
4 (double click on) the approriate script file. 
6 Construct a ZIP file from a map containing:
8 Maps:
10 wordlists - Map with the wordlist maps
11        Add any number of wordlist maps. A wordlist map is a map 
12        with the name of the wordlist and either:
13        wordlist.txt, wordlist.Table or wordlist.tsv
14        Audio recordings corresponding to the pinyin phrases
15        used in the wordlist. The audio filenames must follow the
16        format: <pinyin>.<extension>
17        For instance:
18        ni3hao3.wav
19        da4jia1hao3.spx
21 SGC2 - Map with SpeakGoodChinese binaries (optional)
22            Add any of the following:
23        SGC2/SpeakGoodChinese2.app.zip         - Mac version
24        SGC2/SpeakGoodChinese2.app.zip.md5     - MD5 checksum
25        SGC2/SpeakGoodChinese2.exe             - Windows version
26        SGC2/SpeakGoodChinese2.exe.md5         - MD5 checksum
27        SGC2/SpeakGoodChinese2_linux32.zip     - Linux 32 bit version
28        SGC2/SpeakGoodChinese2_linux32.zip.md5 - MD5 checksum
29        SGC2/SpeakGoodChinese2_linux64.zip     - Linux 64 bit version
30        SGC2/SpeakGoodChinese2_linux64.zip.md5 - MD5 checksum
33 Installation scripts:
34 Double click on the appropriate file
36 Linux_install.sh    - Linux installation script
38 Mac_install.command - Mac installation script
40 Windows_install.bat - Windows installation script