[build] Change to compilation flags for Sequitur on Mac (#1716)
[processor-sdk/kaldi.git] / README.md
1 [![Build Status](https://travis-ci.org/kaldi-asr/kaldi.svg?branch=master)](https://travis-ci.org/kaldi-asr/kaldi)
3 Kaldi Speech Recognition Toolkit
4 ================================
6 To build the toolkit: see `./INSTALL`.  These instructions are valid for UNIX
7 systems including various flavors of Linux; Darwin; and Cygwin (has not been
8 tested on more "exotic" varieties of UNIX).  For Windows installation
9 instructions (excluding Cygwin), see `windows/INSTALL`.
11 To run the example system builds, see `egs/README.txt`
13 If you encounter problems (and you probably will), please do not hesitate to
14 contact the developers (see below). In addition to specific questions, please
15 let us know if there are specific aspects of the project that you feel could be
16 improved, that you find confusing, etc., and which missing features you most
17 wish it had.
19 Kaldi information channels
20 --------------------------
22 For HOT news about Kaldi see [the project site](http://kaldi-asr.org/).
24 [Documentation of Kaldi](http://kaldi-asr.org/doc/):
25 - Info about the project, description of techniques, tutorial for C++ coding.
26 - Doxygen reference of the C++ code.
28 [Kaldi forums and mailing lists](http://kaldi-asr.org/forums.html):
30 We have two different lists
31 - User list kaldi-help
32 - Developer list kaldi-developers:
34 To sign up to any of those mailing lists, go to
35 [http://kaldi-asr.org/forums.html](http://kaldi-asr.org/forums.html):
38 Development pattern for contributors
39 ------------------------------------
41 1. [Create a personal fork](https://help.github.com/articles/fork-a-repo/)
42    of the [main Kaldi repository](https://github.com/kaldi-asr/kaldi) in GitHub.
43 2. Make your changes in a named branch different from `master`, e.g. you create
44    a branch `my-awesome-feature`.
45 3. [Generate a pull request](https://help.github.com/articles/creating-a-pull-request/)
46    through the Web interface of GitHub.
47 4. As a general rule, please follow [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html).
48    There are a [few exceptions in Kaldi](http://kaldi-asr.org/doc/style.html).
49    You can use the [Google's cpplint.py](https://raw.githubusercontent.com/google/styleguide/gh-pages/cpplint/cpplint.py)
50    to verify that your code is free of basic mistakes.
52 Platform specific notes
53 -----------------------
55 ### PowerPC 64bits little-endian (ppc64le)
57 - Kaldi is expected to work out of the box in RHEL >= 7 and Ubuntu >= 16.04 with
58   OpenBLAS, ATLAS, or CUDA.
59 - CUDA drivers for ppc64le can be found at [https://developer.nvidia.com/cuda-downloads](https://developer.nvidia.com/cuda-downloads).
60 - An [IBM Redbook](https://www.redbooks.ibm.com/abstracts/redp5169.html) is
61   available as a guide to install and configure CUDA.
63 ### Android
65 - Kaldi supports cross compiling for Android using Android NDK, clang++ and
66   OpenBLAS.
67 - See [this blog post](http://jcsilva.github.io/2017/03/18/compile-kaldi-android/)
68   for details.