1 [![Build Status](https://travis-ci.org/kaldi-asr/kaldi.svg?branch=master)]
2 (https://travis-ci.org/kaldi-asr/kaldi)
4 Kaldi Speech Recognition Toolkit
5 ================================
7 To build the toolkit: see `./INSTALL`. These instructions are valid for UNIX
8 systems including various flavors of Linux; Darwin; and Cygwin (has not been
9 tested on more "exotic" varieties of UNIX). For Windows installation
10 instructions (excluding Cygwin), see `windows/INSTALL`.
12 To run the example system builds, see `egs/README.txt`
14 If you encounter problems (and you probably will), please do not hesitate to
15 contact the developers (see below). In addition to specific questions, please
16 let us know if there are specific aspects of the project that you feel could be
17 improved, that you find confusing, etc., and which missing features you most
18 wish it had.
20 Kaldi information channels
21 --------------------------
23 For HOT news about Kaldi see [the project site](http://kaldi-asr.org/).
25 [Documentation of Kaldi](http://kaldi-asr.org/doc/):
26 - Info about the project, description of techniques, tutorial for C++ coding.
27 - Doxygen reference of the C++ code.
29 [Kaldi forums and mailing lists](http://kaldi-asr.org/forums.html):
30 - User list kaldi-help:
31 [Web interface/archive](https://groups.google.com/forum/#!forum/kaldi-help) ||
32 [Subscribe] (mailto:kaldi-help+subscribe@googlegroups.com) ||
33 [Post] (mailto:kaldi-help@googlegroups.com)
34 - Developer list kaldi-developers:
35 [Web interface/archive](https://groups.google.com/forum/#!forum/kaldi-developers) ||
36 [Subscribe] (mailto:kaldi-developers+subscribe@googlegroups.com) ||
37 [Post] (mailto:kaldi-developers@googlegroups.com)
38 - Also try luck and search in [SourceForge archives](https://sourceforge.net/p/kaldi/discussion/).
40 Development pattern for contributors
41 ------------------------------------
43 1. [Create a personal fork](https://help.github.com/articles/fork-a-repo/)
44 of the [main Kaldi repository] (https://github.com/kaldi-asr/kaldi) in GitHub.
45 2. Make your changes in a named branch different from `master`, e.g. you create
46 a branch `my-awesome-feature`.
47 3. [Generate a pull request](https://help.github.com/articles/creating-a-pull-request/)
48 through the Web interface of GitHub.
49 4. As a general rule, please follow [Google C++ Style Guide]
50 (https://google-styleguide.googlecode.com/svn/trunk/cppguide.html).
51 There are a [few exceptions in Kaldi](http://kaldi-asr.org/doc/style.html).
52 You can use the [Google's cpplint.py]
53 (https://google-styleguide.googlecode.com/svn/trunk/cpplint/cpplint.py)
54 to verify that your code is free of basic mistakes.