install.dox 2.08 KB
 Dan Povey committed May 14, 2011 1 2 3 // doc/install.dox // Copyright 2009-2011 Microsoft Corporation  Dan Povey committed Jul 16, 2014 4 // 2013-2014 Johns Hopkins University (author: Daniel Povey)  Dan Povey committed May 14, 2011 5   Dan Povey committed Sep 24, 2013 6 7 // See ../../COPYING for clarification regarding multiple authors //  Dan Povey committed May 14, 2011 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // http://www.apache.org/licenses/LICENSE-2.0 // THIS CODE IS PROVIDED *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY // KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED // WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE, // MERCHANTABLITY OR NON-INFRINGEMENT. // See the Apache 2 License for the specific language governing permissions and // limitations under the License. /** \page install Downloading and installing Kaldi  Dan Povey committed Apr 16, 2013 24   kkm committed Aug 03, 2015 25  \section install_download Dowloading Kaldi  Dan Povey committed Apr 16, 2013 26   kkm committed Aug 03, 2015 27  We have now transitioned to GitHub for all future development.  kkm committed Aug 03, 2015 28  You first need to install Git. The most current version of Kaldi,  Dan Povey committed Sep 16, 2012 29  possibly including unfinished and experimental features, can  Dan Povey committed May 14, 2011 30 31  be downloaded by typing into a shell: \verbatim  kkm committed Aug 03, 2015 32 33  git clone https://github.com/kaldi-asr/kaldi.git kaldi-trunk --origin golden cd kaldi-trunk  Dan Povey committed May 14, 2011 34  \endverbatim  Dan Povey committed Jul 16, 2014 35  If you want to get updates and bug fixes you can go to some checked-out  Dan Povey committed Jun 21, 2011 36  directory, and type  Dan Povey committed May 14, 2011 37  \verbatim  kkm committed Aug 03, 2015 38  git pull  Dan Povey committed May 14, 2011 39  \endverbatim  kkm committed Aug 03, 2015 40 41 42 43 44  If "git pull" prints out a message telling it cannot pull the remote changes because you have changed files locally, you may have to commit locally and merge your changes, or stash them temporarily and then apply back the stash; for that, we recommend that you read about how Git works, possibly starting with the \ref tutorial_git.  Dan Povey committed May 14, 2011 45   Dan Povey committed Apr 16, 2013 46   Dan Povey committed May 14, 2011 47  \section install_install Installing Kaldi  kkm committed Aug 03, 2015 48 49 50 51  The top-level installation instructions are in the file \c INSTALL. For Windows, there are separate instructions (unfortunately, not actively maintained and woefully out of date) in \c windows/INSTALL.  Dan Povey committed May 14, 2011 52 53 54  See also \ref build_setup which explains how the build process works internally.  kkm committed Aug 03, 2015 55  The example scripts are in \c egs/  Dan Povey committed Sep 04, 2013 56   Dan Povey committed May 14, 2011 57 */