From f8f83ad64ef95bccc29b20fc5a563fba5a141955 Mon Sep 17 00:00:00 2001 From: Dogan Can Date: Sun, 19 Mar 2017 16:01:40 -0700 Subject: [PATCH] [doc] Add a note to README.md about Android cross compilation (#1503) --- README.md | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 32d4945a909..73abe9f1e3f 100644 --- a/README.md +++ b/README.md @@ -40,25 +40,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.github.io/styleguide/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://raw.githubusercontent.com/google/styleguide/gh-pages/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): +### 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 +- 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.