README

   1 PocketSphinx 0.7
   2
   3 This is PocketSphinx, one of Carnegie Mellon University's open source
   4 large vocabulary, speaker-independent continuous speech recognition
   5 engine. Please see the LICENSE file for terms of use.
   6
   7 THIS IS A RESEARCH SYSTEM.  This is also an early release of a
   8 research system.  We know the APIs and function names are likely to
   9 change, and that several tools need to be made available to make this
  10 all complete.  With your help and contributions, this can progress in
  11 response to the needs and patches provided.
  12
  13 To compile:
  14
  15 First, you *must* have SphinxBase, which you can download from
  16 http://cmusphinx.sourceforge.net/.  You should download and unpack it to
  17 the same parent directory as PocketSphinx, so that the configure script
  18 and project files can find it. On Windows, you will need to rename
  19 'sphinxbase-X.Y' (where X.Y is the SphinxBase version number) to simply
  20 'sphinxbase' for this to work.
  21
  22 In a unix-like environment (such as linux, solaris etc):
  23
  24  * build and optionally install SphinxBase.  If you want to use
  25    fixed-point arithmetic, you *must* configure SphinxBase with the
  26    --enable-fixed option.
  27
  28  * if you downloaded directly from the CVS repository, you need to do
  29    this at least once to generate the "configure" file:
  30
  31 % ./autogen.sh
  32
  33  * if you downloaded the release version, or ran "autogen.sh" at least
  34    once, then compile and install:
  35
  36 % ./configure
  37 % make clean all
  38 % make test
  39 % make install
  40
  41 XCode Installation (for iPhone):
  42
  43 Sphinxbase uses the standard unix autogen system, and there's a script
  44 included, 'build_for_iphone.sh' that will setup configure to create
  45 binaries that are XCode friendly.
  46
  47 1) ./autogen.sh
  48 2) ./build_for_iphone.sh simulator
  49 3) ./build_for_iphone.sh device
  50
  51 Then in XCode, open your project info, and for 'All Configurations', and
  52 set:
  53
  54 'Header Search Paths' = "$(HOME)$(SDK_DIR)/include/pocketsphinx"
  55 'Library Search Paths' = "$(HOME)$(SDK_DIR)/lib"
  56 'Other Linker Flags' = "-lpocketsphinx"
  57
  58 In MS Windows (TM), under MS Visual Studio 2010 (or newer - we test
  59 with Visual C++ 2010 Express):
  60
  61  * load sphinxbase.sln located in sphinxbase directory
  62
  63  * compile all the projects in SphinxBase (from sphinxbase.sln)
  64
  65  * load pocketsphinx.sln in pocketsphinx directory
  66
  67  * compile all the projects in PocketSphinx
  68
  69 MS Visual Studio will build the executables under .\bin\Release or
  70 .\bin\Debug (depending on the version you choose on MS Visual Studio),
  71 and the libraries under .\lib\Release or .\lib\Build.
  72
  73 Test scripts are forthcoming for Windows.
  74
  75 For up-to-date information, see http://cmusphinx.sourceforge.net/
  76