From 67cb3004a31a54c97e9c8108b1087eba2edb1606 Mon Sep 17 00:00:00 2001
From: Hui Zhang <zhtclz@foxmail.com>
Date: Mon, 8 Nov 2021 17:58:11 +0800
Subject: [PATCH] fix doc of install

---
 README.md                   |  3 ++-
 docs/source/install.md      | 44 ++++++-------------------------------
 docs/source/introduction.md |  8 +++----
 3 files changed, 13 insertions(+), 42 deletions(-)

diff --git a/README.md b/README.md
index 76d29bac..290dee52 100644
--- a/README.md
+++ b/README.md
@@ -109,7 +109,7 @@ If you are from China, we strongly recommend you join our PaddleSpeech WeChat gr
 The base environment in this page is  
 - Ubuntu 16.04
 - python>=3.7
-- paddlepaddle==2.1.2
+- paddlepaddle>=2.2.0-rc
 
 If you want to set up PaddleSpeech in other environment, please see the [installation](./docs/source/install.md) documents for all the alternatives.
 
@@ -347,3 +347,4 @@ howpublished = {\url{https://github.com/PaddlePaddle/DeepSpeech}},
 year={2021}
 }
 ```
+
diff --git a/docs/source/install.md b/docs/source/install.md
index f7c8c1c0..0700a166 100644
--- a/docs/source/install.md
+++ b/docs/source/install.md
@@ -6,51 +6,21 @@ To avoid the trouble of environment setup, [running in Docker container](#runnin
 - Python >= 3.7
 - PaddlePaddle latest version (please refer to the [Installation Guide](https://www.paddlepaddle.org.cn/documentation/docs/en/beginners_guide/index_en.html))
 
-## Setup (Important)
-
-- Make sure these libraries or tools installed: `pkg-config`, `flac`, `ogg`, `vorbis`, `boost`, `sox`, and `swig`, e.g. installing them via `apt-get`:
-
-```bash
-sudo apt-get install -y sox pkg-config libflac-dev libogg-dev libvorbis-dev libboost-dev swig python3-dev
-```
-The version of `swig` should >= 3.0
-
-or, installing them via `yum`:
-
-```bash
-sudo yum install pkgconfig libogg-devel libvorbis-devel boost-devel python3-devel
-wget https://ftp.osuosl.org/pub/xiph/releases/flac/flac-1.3.1.tar.xz
-xz -d flac-1.3.1.tar.xz
-tar -xvf flac-1.3.1.tar
-cd flac-1.3.1
-./configure
-make
-make install
-```
+## Simple Setup
 
-- Run the setup script for the remaining dependencies
+For user who working on `Ubuntu` with `root`  privilege.
 
-```bash
+```python
 git clone https://github.com/PaddlePaddle/DeepSpeech.git
 cd DeepSpeech
-pushd tools; make virtualenv.done:; popd
-source tools/venv/bin/activate
 pip install -e .
 ```
 
-- Source venv before do experiment.
+## Setup (Other Platform)
 
-```bash
-source tools/venv/bin/activate
-```
-
-## Simple Setup
-
-```python
-git clone https://github.com/PaddlePaddle/DeepSpeech.git
-cd DeepSpeech
-pip install -e .
-```
+- Make sure these libraries or tools in [dependencies](./dependencies.md) installed. More information please see: `setup.py `and ` tools/Makefile`.
+- The version of `swig` should >= 3.0
+- we will do more to simplify the install process.
 
 ## Running in Docker Container (optional)
 
diff --git a/docs/source/introduction.md b/docs/source/introduction.md
index 206c9908..e7dd2892 100644
--- a/docs/source/introduction.md
+++ b/docs/source/introduction.md
@@ -20,9 +20,9 @@ PaddleSpeech ASR provides you with a complete ASR pipeline, including:
         - fbank (also support kaldi feature)
         - mfcc
 - Acoustic Models
-    - Deepspeech2 (online and offline)
-    - Transformer (online and offline)
-    - Conformer (online and offline)
+    - Deepspeech2 (Streaming and Non-Streaming)
+    - Transformer (Streaming and Non-Streaming)
+    - Conformer (Streaming and Non-Streaming)
 - Decoder
     - ctc greedy search (used in DeepSpeech2, Transformer and Conformer)
     - ctc beam search (used in DeepSpeech2, Transformer and Conformer)
@@ -30,7 +30,7 @@ PaddleSpeech ASR provides you with a complete ASR pipeline, including:
     - attention rescoring (used in Transformer and Conformer)
 
 Speech-To-Text helps you training the ASR model very simply.
-   
+
 ### Text-To-Speech
 TTS mainly consists of components below:
 - Implementation of models and commonly used neural network layers.