install.dox 2.08 KB
Newer Older
1 2 3
// doc/install.dox

// Copyright 2009-2011 Microsoft Corporation
4
//           2013-2014 Johns Hopkins University (author: Daniel Povey)
5

6 7
// See ../../COPYING for clarification regarding multiple authors
//
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

24

25
 \section install_download  Dowloading Kaldi
26

27
  We have now transitioned to GitHub for all future development.
28
  You first need to install Git. The most current version of Kaldi,
29
  possibly including unfinished and experimental features, can
30 31
   be downloaded by typing into a shell:
  \verbatim
32 33
    git clone https://github.com/kaldi-asr/kaldi.git kaldi-trunk --origin golden
    cd kaldi-trunk
34
  \endverbatim
35
 If you want to get updates and bug fixes you can go to some checked-out
Dan Povey's avatar
Dan Povey committed
36
 directory, and type
37
  \verbatim
38
    git pull
39
  \endverbatim
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.
45

46

47
  \section install_install Installing Kaldi
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.
52 53 54
  See also \ref build_setup which explains how the build process
  works internally.

55
  The example scripts are in \c egs/
56

57
*/