diff --git a/README.md b/README.md index 0dcf8b60251df6dd1882b1aa03c5c34f95884ffd..9b48984427743e5245f31e8c76038727f7900e00 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,29 @@ ## Installation -For this project was developed in PaddlePaddle V2 API, which is not maintained officially any more, we only support [running it in Docker container](#running-in-docker-container), instead of building environment from source code. And we are going to release the update to the latest Paddle Fluid API very soon, please keep an eye on this project. +For this project was developed in PaddlePaddle V2 API, which is not maintained officially any more. To avoid the trouble of environment setup, [running in Docker container](#running-in-docker-container) is highly recommended. Otherwise follow the guidelines below to install the dependencies manually. And we are going to release the update to the latest Paddle Fluid API very soon, please keep an eye on this project. +### Prerequisites +- Python 2.7 only supported +- PaddlePaddle the 0.13 version + +```bash +pip install paddlepaddle-gpu==0.13 +``` + +### Setup +- Make sure these libraries or tools installed: `pkg-config`, `flac`, `ogg`, `vorbis`, `boost` and `swig`, e.g. installing them via `apt-get`: + +```bash +sudo apt-get install -y pkg-config libflac-dev libogg-dev libvorbis-dev libboost-dev swig +``` + +- Run the setup script for the remaining dependencies + +```bash +git clone https://github.com/PaddlePaddle/DeepSpeech.git +cd DeepSpeech +sh setup.sh +``` ## Getting Started diff --git a/README_cn.md b/README_cn.md index 06bee58bf5eb302f6619dfbc48d500c55aea85c3..f26c5d9a9cbb45888a4d64e8300fd37b19d5a5f7 100644 --- a/README_cn.md +++ b/README_cn.md @@ -21,7 +21,30 @@ ## 安装 -因该项目基于 PaddlePaddle V2 API 开发,其已不再被官方维护,目前我们仅支持 [在 Docker 容器中运行该项目](#在Docker容器上运行),而不支持从源码构建环境。我们很快会将这个项目升级到最新的 Paddle Fluid API,请保持关注。 +因该项目基于 PaddlePaddle V2 API 开发,其已不再被官方维护,为了避免环境配置问题,强烈建议在[Docker容器上运行](#在Docker容器上运行),否则请按照下面的指南安装依赖项。我们很快会将这个项目升级到最新的 Paddle Fluid API,请保持关注。 + +### 前提 +- 只支持Python 2.7 +- PaddlePaddle 0.13 版本 + +```bash +pip install paddlepaddle-gpu==0.13 +``` + +### 安装 +- 请确保以下库或工具已安装完毕:`pkg-config`, `flac`, `ogg`, `vorbis`, `boost` 和 `swig`, 如可以通过`apt-get`安装: + +```bash +sudo apt-get install -y pkg-config libflac-dev libogg-dev libvorbis-dev libboost-dev swig +``` + +- 运行脚本安装其余的依赖项 + +```bash +git clone https://github.com/PaddlePaddle/DeepSpeech.git +cd DeepSpeech +sh setup.sh +``` ## 开始