[build] dependency-check: that python2.7 and python3 exist and 2.7 is default (#1876)

[processor-sdk/kaldi.git] / README.md

diff --git a/README.md b/README.md
index 2225b9967a4217d6f4e5305211e51feda7361bb5..4496f6270061108babcefa6504f9f38cabbd38ab 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,4 @@
-[![Build Status](https://travis-ci.org/kaldi-asr/kaldi.svg?branch=master)]
-(https://travis-ci.org/kaldi-asr/kaldi)
+[![Build Status](https://travis-ci.org/kaldi-asr/kaldi.svg?branch=master)](https://travis-ci.org/kaldi-asr/kaldi)
 
 Kaldi Speech Recognition Toolkit
 ================================
@@ -40,14 +39,30 @@ 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.
+   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-styleguide.googlecode.com/svn/trunk/cppguide.html).
+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://google-styleguide.googlecode.com/svn/trunk/cpplint/cpplint.py)
+   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.