PraatDemoApp_module

    Copyright (C) 2010-2015  R.J.J.H. van Son and the Netherlands Cancer Institute

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA

Contents:

praat_module: Directory with code to compile Praat script
praat_sources: Directory with praat sources
icons: Directory with .icns (Mac) and .ico (Windows) files
ManPages: Directory with the Manual Pages (not functional yet)
PraatDemoApp.praat: Example Demo praat script
makefile: File to control make
README.txt: This file

Make sure that praat_sources will compile praat. See 
https://github.com/praat/praat for information on how to compile praat

Replace PraatDemoApp.praat with your script. You do not have to keep the 
name. If you only have one script (e.g., include files), you must give 
the name of the file you want to be read in a file called 
"ApplicationName.txt" (just one line of text).

Installation:

1) Open a terminal and "cd" to the directory where you want to 
   build your application.

2) Run the following command
> git clone git://uvafon.hum.uva.nl/PraatDemoApp_module

3) Test that praat_sources does build a running praat executable

4) Run make
> cd PraatDemoApp_module
> make

5) Test whether the executable version of the PraatDemoApp exists and
can be used

Building your own application

1) Replace PraatDemoApp.praat by your own script. 
   With more than one script in the directory, give the name of the 
   script to be read in the file "ApplicationName.txt".

2) Run make
> cd PraatDemoApp_module
> make


Clean slate:

To remove all files produced by running make, run:
> make clean

This will NOT clean the praat_sources build environment. To clean that 
you should use the Praat sources clean commands:
Linux&Windows (removes more than you might want)
> make clean

Mac 32 bit
> xcodebuild -project praat32.xcodeproj clean

Mac 64 bit
> xcodebuild -project praat64.xcodeproj clean


Icons:

If you supply your own icons, as <application_name>.icns (Mac) or
<application_name>.ico (Windows) in the icons directory, these will be 
used when you build the applications.

If you have "convert" installed, other image formats will be converted 
to .ico (Windows) icons. This works for .jpg, .png, .tiff.


ManPages:

Manual pages will be compiled if you supply a directory ManPages with 
the Praat .man files.

To clean up your ManPages run:
> make clean


Source update:

You can update the Praat sources to a different praat version than is
supplied. However, this is only possible if you are able to adapt the
patch files in the praat_module directory. If you do not know how to 
adapt patch files, you should not change the praat sources.

To update the sources for praat, just replace the contents of the 
praat_sources directory with the new sources. Note that this might 
mean that you need to get the correct makefile.defs link in place or 
the correct MacOSX project files. 

To download praat sources:
> git clone https://github.com/praat/praat.git

To replace the sources:
> cd <path to new sources>
> git checkout-index -a -f --prefix='<path to >/PraatDemoApp_module/praat_sources/'

After you have replaced the praat sources, you should update the
patch files in the praat_module directory. 

You can test the patch files by running the testPatch.sh script:
> cd praat_module
> bash testPatch.sh