Update readme (#39)

README.md

@@ -1,168 +1,44 @@
 # Introduction
 
-**Documentation**: <https://k2-fsa.github.io/sherpa/ncnn/index.html>
+You can use `sherpa-ncnn` for **real-time** speech recognition (i.e., speech-to-text)
+on
 
-Try it in colab:
-[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1zdNAdWgV5rh1hLbLDqvLjxTa5tjU7cPa?usp=sharing)
+  - Linux
+  - macOS
+  - Windows
+  - Embedded Linux (32-bit arm and 64-bit aarch64)
+  - Android
+  - etc ...
 
-We provide two YouTube videos for demonstration about real-time speech recognition
-with `sherpa-ncnn` from a microphone:
+We support all platforms that [ncnn](https://github.com/tencent/ncnn) supports.
+
+Everything can be compiled from source with static link. The generated
+executable depends only on system libraries.
+
+Please see the documentation <https://k2-fsa.github.io/sherpa/ncnn/index.html>
+for installation and usages, e.g.,
+
+  - How to build an Android app
+  - How to download and use pre-trained models
+
+We provide a few YouTube videos for demonstration about real-time speech recognition
+with `sherpa-ncnn` using a microphone:
 
   - `English`: <https://www.youtube.com/watch?v=m6ynSxycpX0>
   - `Chinese`: <https://www.youtube.com/watch?v=bbQfoRT75oM>
+  - `Chinese + English` Android demo: <https://www.youtube.com/shorts/S5Owcrb8vzU>
+  - `Chinese (with background noise)` Android demo : <https://www.youtube.com/shorts/KI1-d-W9uZw>
+  - `Chinese` Android demo : <https://www.youtube.com/shorts/lpDAG36T1R4>
+  - `Chinese poem with background music` Android demo : <https://www.youtube.com/shorts/5CJ-r8VNuwo>
 
 **Note**: If you don't have access to YouTube, we provide the links
 in bilibili below:
 
   - `English`: <https://www.bilibili.com/video/BV1TP411p7dh/>
   - `Chinese`: <https://www.bilibili.com/video/BV1214y177vu>
+  - `Chinese + English` Android demo: <https://www.bilibili.com/video/BV1Ge411A7XS>
+  - `Chinese (with background noise)` Android demo : <https://www.bilibili.com/video/BV1GR4y167fx>
+  - `Chinese` Android demo : <https://www.bilibili.com/video/BV1744y1Z76H>
+  - `Chinese poem with background music` Android demo : <https://www.bilibili.com/video/BV1vR4y1k7eo>
 
-See <https://github.com/k2-fsa/sherpa>
-
-This repo uses [ncnn](https://github.com/tencent/ncnn) for running the neural
-network model and does not depend on libtorch.
-
-Please read <https://k2-fsa.github.io/icefall/recipes/librispeech/lstm_pruned_stateless_transducer.html>
-if you are interested in how the model is trained.
-
-We provide exported models in ncnn format and they can be downloaded using
-the following links:
-
-**LSTM transducer**
-
-  - English: <https://huggingface.co/csukuangfj/sherpa-ncnn-2022-09-05>
-  - Chinese: <https://huggingface.co/csukuangfj/sherpa-ncnn-2022-09-30>
-
-**ConvEmformer transducer**
-
-  - English: <https://huggingface.co/csukuangfj/sherpa-ncnn-conv-emformer-transducer-2022-12-04>
-  - Chinese + English (all-in-one): <https://huggingface.co/csukuangfj/sherpa-ncnn-conv-emformer-transducer-2022-12-06>
-  - Chinese (18.6 M parameters): <https://huggingface.co/csukuangfj/sherpa-ncnn-conv-emformer-transducer-2022-12-08>
-
-## Build for Linux/macOS
-
-```bash
-git clone https://github.com/k2-fsa/sherpa-ncnn
-cd sherpa-ncnn
-mkdir build
-cd build
-cmake -DCMAKE_BUILD_TYPE=Release ..
-make -j6
-cd ..
-```
-
-## Download the pretrained model (Chinese)
-
-**Caution**: You have to run `git lfs install`. Otherwise, you will be **SAD** later.
-
-```bash
-git lfs install
-git clone https://huggingface.co/csukuangfj/sherpa-ncnn-2022-09-30
-
-./build/bin/sherpa-ncnn \
-  ./sherpa-ncnn-2022-09-30/tokens.txt \
-  ./sherpa-ncnn-2022-09-30/encoder_jit_trace-v2-epoch-11-avg-2-pnnx.ncnn.param \
-  ./sherpa-ncnn-2022-09-30/encoder_jit_trace-v2-epoch-11-avg-2-pnnx.ncnn.bin \
-  ./sherpa-ncnn-2022-09-30/decoder_jit_trace-v2-epoch-11-avg-2-pnnx.ncnn.param \
-  ./sherpa-ncnn-2022-09-30/decoder_jit_trace-v2-epoch-11-avg-2-pnnx.ncnn.bin \
-  ./sherpa-ncnn-2022-09-30/joiner_jit_trace-v2-epoch-11-avg-2-pnnx.ncnn.param \
-  ./sherpa-ncnn-2022-09-30/joiner_jit_trace-v2-epoch-11-avg-2-pnnx.ncnn.bin \
-  ./sherpa-ncnn-2022-09-30/test_wavs/0.wav
-
-# You will find executables in ./bin/
-```
-
-## Build for Windows
-
-```bash
-git clone https://github.com/k2-fsa/sherpa-ncnn
-cd sherpa-ncnn
-mkdir build
-cd build
-cmake -DCMAKE_BUILD_TYPE=Release ..
-cmake --build . --config Release
-cd ..
-
-# You will find executables in ./bin/Release
-```
-
-## Download the pretrained model (Chinese)
-
-**Caution**: You have to run `git lfs install`. Otherwise, you will be **SAD** later.
-
-```bash
-git lfs install
-git clone https://huggingface.co/csukuangfj/sherpa-ncnn-2022-09-30
-
-./build/bin/sherpa-ncnn \
-  ./sherpa-ncnn-2022-09-30/tokens.txt \
-  ./sherpa-ncnn-2022-09-30/encoder_jit_trace-v2-epoch-11-avg-2-pnnx.ncnn.param \
-  ./sherpa-ncnn-2022-09-30/encoder_jit_trace-v2-epoch-11-avg-2-pnnx.ncnn.bin \
-  ./sherpa-ncnn-2022-09-30/decoder_jit_trace-v2-epoch-11-avg-2-pnnx.ncnn.param \
-  ./sherpa-ncnn-2022-09-30/decoder_jit_trace-v2-epoch-11-avg-2-pnnx.ncnn.bin \
-  ./sherpa-ncnn-2022-09-30/joiner_jit_trace-v2-epoch-11-avg-2-pnnx.ncnn.param \
-  ./sherpa-ncnn-2022-09-30/joiner_jit_trace-v2-epoch-11-avg-2-pnnx.ncnn.bin \
-  ./sherpa-ncnn-2022-09-30/test_wavs/0.wav
-
-# If you are using Windows, please use ./build/bin/Release/sherpa-ncnn
-
-# If you get encoding issues on Windows, please run
-#  CHCP 65001
-# in you commandline window.
-```
-
-To do speech recognition in real-time with a microphone, run:
-
-```bash
-./build/bin/sherpa-ncnn-microphone \
-  ./sherpa-ncnn-2022-09-30/tokens.txt \
-  ./sherpa-ncnn-2022-09-30/encoder_jit_trace-v2-epoch-11-avg-2-pnnx.ncnn.param \
-  ./sherpa-ncnn-2022-09-30/encoder_jit_trace-v2-epoch-11-avg-2-pnnx.ncnn.bin \
-  ./sherpa-ncnn-2022-09-30/decoder_jit_trace-v2-epoch-11-avg-2-pnnx.ncnn.param \
-  ./sherpa-ncnn-2022-09-30/decoder_jit_trace-v2-epoch-11-avg-2-pnnx.ncnn.bin \
-  ./sherpa-ncnn-2022-09-30/joiner_jit_trace-v2-epoch-11-avg-2-pnnx.ncnn.param \
-  ./sherpa-ncnn-2022-09-30/joiner_jit_trace-v2-epoch-11-avg-2-pnnx.ncnn.bin
-
-# If you are using Windows, please use ./build/bin/Release/sherpa-ncnn-microphone.exe
-```
-
-## Download the pretrained model (English)
-
-```bash
-git lfs install
-git clone https://huggingface.co/csukuangfj/sherpa-ncnn-2022-09-05
-
-./build/bin/sherpa-ncnn \
-  ./sherpa-ncnn-2022-09-05/tokens.txt \
-  ./sherpa-ncnn-2022-09-05/bar/encoder_jit_trace-v2-iter-468000-avg-16-pnnx.ncnn.param \
-  ./sherpa-ncnn-2022-09-05/bar/encoder_jit_trace-v2-iter-468000-avg-16-pnnx.ncnn.bin \
-  ./sherpa-ncnn-2022-09-05/bar/decoder_jit_trace-v2-iter-468000-avg-16-pnnx.ncnn.param \
-  ./sherpa-ncnn-2022-09-05/bar/decoder_jit_trace-v2-iter-468000-avg-16-pnnx.ncnn.bin \
-  ./sherpa-ncnn-2022-09-05/bar/joiner_jit_trace-v2-iter-468000-avg-16-pnnx.ncnn.param \
-  ./sherpa-ncnn-2022-09-05/bar/joiner_jit_trace-v2-iter-468000-avg-16-pnnx.ncnn.bin \
-  ./sherpa-ncnn-2022-09-05/test_wavs/1089-134686-0001.wav
-
-# If you are using Windows, please use ./build/bin/Release/sherpa-ncnn.exe
-```
-
-To do speech recognition in real-time with a microphone, run:
-
-```bash
-./build/bin/sherpa-ncnn-microphone \
-  ./sherpa-ncnn-2022-09-05/tokens.txt \
-  ./sherpa-ncnn-2022-09-05/bar/encoder_jit_trace-v2-iter-468000-avg-16-pnnx.ncnn.param \
-  ./sherpa-ncnn-2022-09-05/bar/encoder_jit_trace-v2-iter-468000-avg-16-pnnx.ncnn.bin \
-  ./sherpa-ncnn-2022-09-05/bar/decoder_jit_trace-v2-iter-468000-avg-16-pnnx.ncnn.param \
-  ./sherpa-ncnn-2022-09-05/bar/decoder_jit_trace-v2-iter-468000-avg-16-pnnx.ncnn.bin \
-  ./sherpa-ncnn-2022-09-05/bar/joiner_jit_trace-v2-iter-468000-avg-16-pnnx.ncnn.param \
-  ./sherpa-ncnn-2022-09-05/bar/joiner_jit_trace-v2-iter-468000-avg-16-pnnx.ncnn.bin
-
-# If you are using Windows, please use ./build/bin/Release/sherpa-ncnn-microphone.exe
-
-# If you get encoding issues on Windows, please run
-#  CHCP 65001
-# in you commandline window.
-```
-
-
-[ncnn]: https://github.com/tencent/ncnn
+See also <https://github.com/k2-fsa/sherpa>