README.md

   1 [![Build Status](https://travis-ci.org/kaldi-asr/kaldi.svg?branch=master)]
   2 (https://travis-ci.org/kaldi-asr/kaldi)
   3
   4 Kaldi Speech Recognition Toolkit
   5 ================================
   6
   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`.
  11
  12 To run the example system builds, see `egs/README.txt`
  13
  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.
  19
  20 Kaldi information channels
  21 --------------------------
  22
  23 For HOT news about Kaldi see [the project site](http://kaldi-asr.org/).
  24
  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.
  28
  29 [Kaldi forums and mailing lists](http://kaldi-asr.org/forums.html):
  30
  31 We have two different lists
  32 - User list kaldi-help
  33 - Developer list kaldi-developers:
  34
  35 To sign up to any of those mailing lists, go to
  36 [http://kaldi-asr.org/forums.html](http://kaldi-asr.org/forums.html):
  37
  38
  39 Development pattern for contributors
  40 ------------------------------------
  41
  42 1. [Create a personal fork](https://help.github.com/articles/fork-a-repo/)
  43    of the [main Kaldi repository] (https://github.com/kaldi-asr/kaldi) in GitHub.
  44 2. Make your changes in a named branch different from `master`, e.g. you create
  45    a branch `my-awesome-feature`.
  46 3. [Generate a pull request](https://help.github.com/articles/creating-a-pull-request/)
  47    through the Web interface of GitHub.
  48 4. As a general rule, please follow [Google C++ Style Guide]
  49    (https://google.github.io/styleguide/cppguide.html).
  50    There are a [few exceptions in Kaldi](http://kaldi-asr.org/doc/style.html).
  51    You can use the [Google's cpplint.py]
  52    (https://raw.githubusercontent.com/google/styleguide/gh-pages/cpplint/cpplint.py)
  53    to verify that your code is free of basic mistakes.
  54
  55 Platform specific notes
  56 -----------------------
  57
  58 PowerPC 64bits little-endian (ppc64le):
  59 - Kaldi is expected to work out of the box in RHEL >= 7 and Ubuntu >= 16.04 with
  60   OpenBLAS, ATLAS, or CUDA.
  61 - CUDA drivers for ppc64le can be found at [https://developer.nvidia.com/cuda-downloads]
  62   (https://developer.nvidia.com/cuda-downloads).
  63 - An [IBM Redbook] (https://www.redbooks.ibm.com/abstracts/redp5169.html) is
  64   available as a guide to install and configure CUDA.