aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorIan Hodson <idh@google.com>2012-05-30 21:27:06 +0100
committerIan Hodson <idh@google.com>2012-05-30 22:47:36 +0100
commitf4c12fce1ee58e670f9c3fce46c40296ba9ee8a2 (patch)
treeb131ed907f9b2d5af09c0983b651e9e69bc6aab9 /README
parenta92766f0a6ba4fac46cd6fd3856ef20c3b204f0d (diff)
downloadopenfst-f4c12fce1ee58e670f9c3fce46c40296ba9ee8a2.tar.gz
Moved from GoogleTTS Change-Id: I6bc6bdadaa53bd0f810b88443339f6d899502cc8
Diffstat (limited to 'README')
-rw-r--r--README44
1 files changed, 44 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..a4643d7
--- /dev/null
+++ b/README
@@ -0,0 +1,44 @@
+OpenFst - Release 1.2
+
+OpenFst is a library for constructing, combining, optimizing, and
+searching weighted finite-state transducers (FSTs).
+
+REQUIREMENTS:
+ This version is known to work under Linux, MacOS, and Solaris using
+ g++ (>= 4.1). Expected to work wherever adequate POSIX (dlopen, ssize_t,
+ basename), c99 (snprintf, strtoll, <stdint.h>), and tr1 (<tr1/ordered_set>,
+ <tr1/ordered_map>) support are available.
+
+INSTALLATION:
+ Follow the generic GNU build system instructions in ./INSTALL. We
+ recommend configuring with =--enable-static=no= for faster
+ compiles.
+
+ Optional features:
+ --enable-bin Build fst::script and command-line binaries (def: yes)
+ --enable-compact-fsts Enable all CompactFst classes (def: no)
+ --enable-const-fsts Enable all ConstFst classes (def: no)
+ --enable-far Enable FAR (FST Archive) extension (def: no)
+ --enable-lookahead-fsts Enable LookAheadFst classes (def: no)
+ --enable-pdt Experimental push-down transducer extensions (def: no)
+ --with-icu Use ICU to provide unicode support (def: no)
+
+ Configuring with --enable-bin=no gives very fast compiles, but
+ excludes the command line utilities.
+
+ Compiling with '-Wall -Wno-sign-compare' under g++ should give no
+ warnings from this library.
+
+USAGE:
+ Assuming you've installed under the default /usr/local, the FST
+ binaries are found on /usr/local/bin. To use in your own program,
+ include <fst/fstlib.h> and compile with '-I /usr/local/include'.
+ Link against /usr/local/lib/libfst.so and -ldl. Set your
+ LD_LIBRARY_PATH (or equivalent) to contain /usr/local/lib. The
+ linking is, by default, dynamic so that the Fst and Arc type DSO
+ extensions can be used correctly if desired. Any extensions will
+ be found under /usr/local/include/fst/extensions and /usr/local/lib/fst.
+
+DOCUMENTATION:
+ See www.openfst.org for general documentation.
+ See ./NEWS for updates since the last release.