README

   1 CMU Sphinx common libraries
   2 ---------------------------
   3
   4 This package contains the basic libraries shared by the CMU Sphinx
   5 trainer and all the Sphinx decoders (Sphinx-II, Sphinx-III, and
   6 PocketSphinx), as well as some common utilities for manipulating
   7 acoustic feature and audio files.
   8
   9 Installation Guide:
  10
  11 This section contains installation for various platforms
  12
  13 Linux/Unix installation
  14 ^^^^^^^^^^^^^^^^^^^^^^^
  15
  16 sphinxbase is used by other modules.  The convention requires the
  17 physical layout of the code looks like this:
  18     package/
  19     sphinxbase/
  20
  21 So if you get the file from a distribution, you might want to rename
  22 sphinxbase-X.X to sphinxbase by typing
  23
  24     > mv sphinxbase-X.X sphinxbase (where X.X being the version of sphinxbase)
  25
  26 If you downloaded directly from the Subversion repository, you need to
  27 create the "configure" file by typing
  28
  29     > ./autogen.sh
  30
  31 If you downloaded a release version or if you have already run
  32 "autogen.sh", you can build simply by running
  33
  34     > ./configure
  35     > make
  36
  37 If you are compiling for a platform without floating-point arithmetic,
  38 you should instead use:
  39
  40     > ./configure --enable-fixed --without-lapack
  41     > make
  42
  43 You can also check the validity of the package by typing
  44
  45     > make check
  46
  47 and then install it with
  48
  49     > make install
  50
  51 This defaults to installing SphinxBase under /usr/local. You may
  52 customize it by running ./configure with an argument, as in
  53
  54     >./configure --prefix=/my/own/installation/directory
  55
  56 XCode Installation (for iPhone):
  57 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  58 Sphinxbase uses the standard unix autogen system, and there's a script
  59 included, 'build_for_iphone.sh' that will setup configure to create
  60 binaries that are XCode friendly.
  61
  62 1) ./autogen.sh
  63 2) ./build_for_iphone.sh simulator
  64 3) ./build_for_iphone.sh device
  65
  66 Then in XCode, open your project info, and for 'All Configurations', and
  67 set:
  68
  69 'Header Search Paths' = "$(HOME)$(SDK_DIR)/include/sphinxbase"
  70 'Library Search Paths' = "$(HOME)$(SDK_DIR)/lib"
  71 'Other Linker Flags' = "-lsphinxbase"
  72
  73 Windows Installation:
  74 ^^^^^^^^^^^^^^^^^^^^^
  75 To compile sphinxbase in Visual Studio 2010 Express (or newer):
  76 1, unzip the file.
  77 2, rename the directory to sphinxbase
  78 3, go into the sphinxbase folder and click sphinxbase.sln
  79 4, in the menu, choose Build -> Rebuild All -> Batch Build -> Build
  80
  81 In Step 4, make sure all projects are selected, preferably the
  82 "Release" version of each.
  83
  84 If you are using cygwin, the installation procedure is very similar to
  85 the Unix installation. However, there is no audio driver support in
  86 cygwin currently so one can only use the batch mode recognzier.
  87