diff --git a/README.md b/README.md
index b67f5ae3fa97ae59247803dbf0f5843d709a1596..4496f6270061108babcefa6504f9f38cabbd38ab 100644 (file)
--- a/README.md
+++ b/README.md
-ABOUT
-=====
- * This is a Git mirror of [Svn trunk of Kaldi project](http://sourceforge.net/projects/kaldi/)
- `svn://svn.code.sf.net/p/kaldi/code/trunk`
- * In the branch `master` I commit my work. In the branch `svn_mirror` I mirror `svn://svn.code.sf.net/p/kaldi/code/trunk`. In the branch `sandbox-oplatek` I am developing changes which I would like to check in back to Kaldi.
- * Currently, I mirror the repository manually as often as I needed.
- * The main purpose for mirroring is that I want to build my own decoder and train my models for decoding based on up-to-date Kaldi version.
- * Recipe for training the models can be found at `egs/kaldi-vystadial-recipe`
- * Source code for python wrapper for online-decoder is at `src/python-kaldi-decoding`
- * Remarks about new decoder are located at `src/vystadial-decoder`
- * I use the `Fake submodules` approach to merge the 3 subprojects to this repository. More about `Fake submodules` [at this blog](http://debuggable.com/posts/git-fake-submodules:4b563ee4-f3cc-4061-967e-0e48cbdd56cb).
- * I mirror the svn via `git svn`. [Nice intro to git svn](http://viget.com/extend/effectively-using-git-with-subversion), [Walk through](http://blog.shinetech.com/2009/02/17/my-git-svn-workflow/) and [Multiple svn-remotes](http://blog.shuningbian.net/2011/05/git-with-multiple-svn-remotes.html)
-
-OTHER INFO
-----------
- * Read `INSTALL.md` and `INSTALL` first!
- * For training models read `egs/kaldi-vystadial-recipe/s5/README.md`
- * For building and developing decoder callable from python read `src/python-kaldi-decoding/README.md`
- * For information about new decoder read `src/vystadial-decoder/README.md`
- * This work is done under [Vystadial project](https://sites.google.com/site/filipjurcicek/projects/vystadial).
-
-LICENSE
---------
- * We release all the changes at pyKaldi under `Apache license 2.0` license. Kaldi also uses `Apache 2.0` license).
- * We also want to publicly release the training data in the autumn 2013.
+[](https://travis-ci.org/kaldi-asr/kaldi)
+
+Kaldi Speech Recognition Toolkit
+================================
+
+To build the toolkit: see `./INSTALL`. These instructions are valid for UNIX
+systems including various flavors of Linux; Darwin; and Cygwin (has not been
+tested on more "exotic" varieties of UNIX). For Windows installation
+instructions (excluding Cygwin), see `windows/INSTALL`.
+
+To run the example system builds, see `egs/README.txt`
+
+If you encounter problems (and you probably will), please do not hesitate to
+contact the developers (see below). In addition to specific questions, please
+let us know if there are specific aspects of the project that you feel could be
+improved, that you find confusing, etc., and which missing features you most
+wish it had.
+
+Kaldi information channels
+--------------------------
+
+For HOT news about Kaldi see [the project site](http://kaldi-asr.org/).
+
+[Documentation of Kaldi](http://kaldi-asr.org/doc/):
+- Info about the project, description of techniques, tutorial for C++ coding.
+- Doxygen reference of the C++ code.
+
+[Kaldi forums and mailing lists](http://kaldi-asr.org/forums.html):
+
+We have two different lists
+- User list kaldi-help
+- Developer list kaldi-developers:
+
+To sign up to any of those mailing lists, go to
+[http://kaldi-asr.org/forums.html](http://kaldi-asr.org/forums.html):
+
+
+Development pattern for contributors
+------------------------------------
+
+1. [Create a personal fork](https://help.github.com/articles/fork-a-repo/)
+ of the [main Kaldi repository](https://github.com/kaldi-asr/kaldi) in GitHub.
+2. Make your changes in a named branch different from `master`, e.g. you create
+ a branch `my-awesome-feature`.
+3. [Generate a pull request](https://help.github.com/articles/creating-a-pull-request/)
+ through the Web interface of GitHub.
+4. As a general rule, please follow [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html).
+ There are a [few exceptions in Kaldi](http://kaldi-asr.org/doc/style.html).
+ You can use the [Google's cpplint.py](https://raw.githubusercontent.com/google/styleguide/gh-pages/cpplint/cpplint.py)
+ to verify that your code is free of basic mistakes.
+
+Platform specific notes
+-----------------------
+
+### PowerPC 64bits little-endian (ppc64le)
+
+- Kaldi is expected to work out of the box in RHEL >= 7 and Ubuntu >= 16.04 with
+ OpenBLAS, ATLAS, or CUDA.
+- CUDA drivers for ppc64le can be found at [https://developer.nvidia.com/cuda-downloads](https://developer.nvidia.com/cuda-downloads).
+- An [IBM Redbook](https://www.redbooks.ibm.com/abstracts/redp5169.html) is
+ available as a guide to install and configure CUDA.
+
+### Android
+
+- Kaldi supports cross compiling for Android using Android NDK, clang++ and
+ OpenBLAS.
+- See [this blog post](http://jcsilva.github.io/2017/03/18/compile-kaldi-android/)
+ for details.