Commit 08024e90 authored by kkm's avatar kkm

Documentation changes: added Git tutorial, removed Subversion tutorial and...

Documentation changes: added Git tutorial, removed Subversion tutorial and updated multiple references from Subversion to Git and from SourceForge to Kaldi's own web site or GitHub as appropriate.
parent 1d24e8c9
......@@ -134,12 +134,9 @@
Note: after an early phase in which we intended to use version numbers for
major releases of Kaldi ("v1" and so on), we realized that these type of
releases do not mesh well with the natural style of development, which is very
continuous. Currently we maintain two major versions of Kaldi: the "trunk"
version, and the "complete" version (which maintains some little-used features
that were deleted from trunk). We also maintain various sandboxes for feature
development; these are merged back into trunk when the feature is complete.
For most purposes, the "trunk" is the version you should use, and you should
frequently do "svn up" to keep it up to date; see \ref install for more details.
continuous. Currently we maintain only the "master" development branch, and
this is the version you should use. Also,
frequently do "git pull" to keep it up to date; see \ref install for more details.
See \ref roadmap for details of features we are currently working on.
......
......@@ -73,7 +73,7 @@
order to install Kaldi. The full list is not important since the installation
scripts will tell you what you are missing.
- Subversion (svn): this is needed to download Kaldi and other software that it depends on.
- Git: this is needed to download Kaldi and other software that it depends on.
- wget is required for the installation of some non-Kaldi components described below
- The example scripts require standard UNIX utilities such as bash,
perl, awk, grep, and make.
......
......@@ -22,54 +22,40 @@
\page install Downloading and installing Kaldi
\section install_transition Transition to github
\section install_download Dowloading Kaldi
Due to the long recent sourceforge outage, we have now transitioned to
github for all future development. We still intend to maintain a
read-only subversion mirror of the github parent, located at sourceforge and mirrored
by us; however, we won't be able to set that up until Sourceforge comes back up.
We have now transitioned to
GitHub for all future development. We still intend to maintain a
read-only Subversion mirror of the GitHub parent, located at SourceForge and mirrored
by us.
While sourceforge is still down, the easiest way to access Kaldi as follows:
\verbatim
git clone https://github.com/kaldi-asr/kaldi.git
\endverbatim
You can then keep it up-to-date using "git pull".
When sourceforge comes back up, you will be free to access it either through github
or through the subversion commands below.
If you may want to contribute to Kaldi, this will mostly be done using pull requests.
You would first log in to github and go to https://github.com/kaldi-asr/kaldi and click on
"fork" to fork the repository. Then, in your local fork of the repository you would
do your work in a differently named branch, and generate a pull request through the
online interface of github. We will soon provide more detailed instructions on this.
\section install_download Dowloading Kaldi (old instructions)
You first need to install Subversion (SVN). The most current version of Kaldi,
You first need to install Git. The most current version of Kaldi,
possibly including unfinished and experimental features, can
be downloaded by typing into a shell:
\verbatim
svn co https://svn.code.sf.net/p/kaldi/code/trunk kaldi-trunk
git clone https://github.com/kaldi-asr/kaldi.git kaldi-trunk --origin golden
cd kaldi-trunk
\endverbatim
If you want to get updates and bug fixes you can go to some checked-out
directory, and type
\verbatim
svn update
git pull
\endverbatim
If "svn update" prints out scary looking messages about conflicts (caused by
you changing parts of files that were later modified centrally),
you may have to resolve the conflicts; for that, we recommend that you
read about how svn works.
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.
\section install_install Installing Kaldi
The top-level installation instructions are in the file INSTALL.
For Windows, there are separate instructions (unfortunately, not actively maintained and woefully out of date)
in windows/INSTALL.
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.
See also \ref build_setup which explains how the build process
works internally.
The example scripts are in egs/
The example scripts are in \c egs/
*/
......@@ -118,7 +118,7 @@
a kind of shorthand for the whole multiple-header thing (this is
explained in the COPYING file). The way you can disambiguate
between joint copyright ownership and derivative work, is to
go back in the version history in subversion, and see what the original
go back in the version history in Git, and see what the original
release contained. We guess that most people won't care about
this distinction, which is why we have not bothered to disambiguate it.
For shell and perl scripts and other non-C++ content
......
......@@ -23,18 +23,15 @@
\page other Other Kaldi-related resources (and how to get help)
The main places where Kaldi knowledge can be found are this website,
and in the code repository (which we are currently in the process of moving
from subversion to git; see \ref install for instructions).
and in the code repository (see \ref install for instructions).
The repository contains the Kaldi code; the installation scripts;
and example scripts for a number of different datasets, which are located
in the sub-directory egs/).
in the sub-directory \c egs/).
Kaldi's <a href=http://sourceforge.net/projects/kaldi/>project page on Sourceforge</a> contains
a number of useful resources, but after the recent extended outage we are migrating away from
Sourceforge. <a href=http://kaldi-asr.org/>kaldi-asr.org/</a> is now the top-level
location you should go to; see in particular information about help forums and email
lists at <a href=http://kaldi-asr.org/forums.html>kaldi-asr.org/forums.html</a>.
Kaldi's <a href="http://kaldi-asr.org/">project page</a> contains
a number of useful resources; see in particular information about help forums and email
lists at <a href="http://kaldi-asr.org/forums.html">kaldi-asr.org/forums.html</a>.
......
......@@ -22,7 +22,7 @@
- \subpage tutorial_prereqs "Prerequisites"
- \subpage tutorial_setup "Getting started" (15 minutes)
- \subpage tutorial_svn "Version control with Subversion" (5 minutes)
- \subpage tutorial_git "Version control with Git" (5 minutes)
- \subpage tutorial_looking "Overview of the distribution" (25 minutes)
- \subpage tutorial_running "Running the example scripts" (40 minutes)
- \subpage tutorial_code "Reading and modifying the code" (30 minutes)
......
......@@ -169,6 +169,7 @@ If you need to debug a program that takes command-line arguments, you can do it
\endverbatim
or you can invoke gdb without arguments and then type "r arg1 arg2..." at the prompt.
\todo This paragraph is full of lies!
When you are done, and it compiles, type
\verbatim
svn diff
......
This diff is collapsed.
......@@ -21,7 +21,7 @@
\page tutorial_looking Kaldi tutorial: Overview of the distribution (20 minutes)
\ref tutorial "Up: Kaldi tutorial" <BR>
\ref tutorial_svn "Previous: Version control with Subversion" <BR>
\ref tutorial_git "Previous: Version control with Git" <BR>
\ref tutorial_running "Next: Running the example scripts" <BR>
Before we jump into the example scripts, let us take a few minutes to look at what
......@@ -234,7 +234,7 @@ a build process, one solution is to try modifying kaldi.mk by hand. In order to
probably understand how Kaldi makes use of external math libraries (see \ref matrixwrap).
\ref tutorial "Up: Kaldi tutorial" <BR>
\ref tutorial_svn "Previous: Version control with Subversion" <BR>
\ref tutorial_git "Previous: Version control with Git" <BR>
\ref tutorial_running "Next: Running the example scripts" <BR>
<P>
*/
......@@ -47,7 +47,7 @@
a different distribution of the RM data with a different layout.
The system requirements are fairly basic. We assume that you have tools
including wget, svn, awk, perl and so on, or that you know how to install them.
including wget, git, awk, perl and so on, or that you know how to install them.
The most difficult part of the installation process relates to the math library
ATLAS; if this is not already installed as a library on your system you will
have to compile it, and this requires that CPU throttling be turned off, which
......
......@@ -22,7 +22,7 @@
\ref tutorial "Up: Kaldi tutorial" <BR>
\ref tutorial_prereqs "Previous: Prerequisites" <BR>
\ref tutorial_svn "Next: Version control with Subversion" <BR>
\ref tutorial_git "Next: Version control with Git" <BR>
The first step is to download and install Kaldi. We will be using version 1 of
the toolkit, so that this tutorial does not get out of date. However, be aware
......@@ -32,9 +32,9 @@
"s3" scripts mentioned in this tutorial. But be aware that if you do that some
aspects of the tutorial may be out of date.
Assuming Subversion (svn) is installed, to get the latest code you can type
Assuming Git is installed, to get the latest code you can type
\verbatim
svn co svn://svn.code.sf.net/p/kaldi/code/trunk kaldi-trunk
git clone https://github.com/kaldi-asr/kaldi.git kaldi-trunk --origin golden
\endverbatim
Then cd to kaldi-trunk. Look at the INSTALL file and follow the instructions
(it points you to two subdirectories). Look carefully at the output of the
......@@ -54,6 +54,6 @@
\ref tutorial "Up: Kaldi tutorial" <BR>
\ref tutorial_prereqs "Previous: Prerequisites" <BR>
\ref tutorial_svn "Next: Version control with Subversion" <BR>
\ref tutorial_git "Next: Version control with Git" <BR>
<P>
*/
// doc/tutorial_svn.dox
// Copyright 2009-2011 Microsoft Corporation
// See ../../COPYING for clarification regarding multiple authors
//
// 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 tutorial_svn Kaldi Tutorial: Version control with Subversion (5 minutes)
\ref tutorial "Up: Kaldi tutorial" <BR>
\ref tutorial_setup "Previous: Getting started" <BR>
\ref tutorial_looking "Next: Overview of the distribution" <BR>
In case you are unfamiliar with the Subversion (svn) version control system, we
give a brief overview of some commands that might be useful to you. Subversion commands
always look like: "svn [command] [arguments]"; you can do "svn help" to see what
commands are available, or "svn help <command>" for help on a specific command.
In kaldi-1 or any subdirectory, type
\verbatim
svn up
\endverbatim
(this is short for "svn update"). If we have committed changes to the repository
in the several minutes since you installed Kaldi, you should see output like
the following:
\verbatim
kaldi-1: svn update
U src/lat/Makefile
U src/nnetbin/nnet-forward.cc
Updated to revision 191.
\endverbatim
More likely, it will just say something like "At revision 191."
To see if you have made any changes to anything, type
\verbatim
svn status
\endverbatim
This will
list files that you changed or that have been added. Files that have been added
to the directories but are not under version control because you have not used the
"svn add" command, will appear with the descriptor '?' (you will see all the
binaries that were compiled). Next, edit a version-controlled file (for example,
src/Makefile; add a comment or something), and type
\verbatim
svn diff
\endverbatim
This should show how your version differs from the copy that you downlaoded.
If you are going to be
contributing to the Kaldi project (and we do welcome new contributors),
then you should become familiar with other commands such
as "svn add", "svn commit" and so on. For this, there are tutorials available
online.
\ref tutorial "Up: Kaldi tutorial" <BR>
\ref tutorial_setup "Previous: Getting started" <BR>
\ref tutorial_looking "Next: Overview of the distribution" <BR>
<P>
*/
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment