From 2072abeb7007db779f2dc6dc26eb88336c7694ac Mon Sep 17 00:00:00 2001
From: Binbin Zhang <binbzha@qq.com>
Date: Fri, 19 Nov 2021 12:24:47 +0800
Subject: [PATCH] [doc] add install guide (#8)

---
 README.md        | 17 +++++++++++++++++
 requirements.txt |  4 ++++
 2 files changed, 21 insertions(+)
 create mode 100644 requirements.txt

diff --git a/README.md b/README.md
index 15ca86b..ebf8988 100644
--- a/README.md
+++ b/README.md
@@ -16,6 +16,23 @@ We are going to support the following typical applications of wakeup word:
 * Customizable wake-up word
 * Personalized wake-up word, i.e. combination of wake-up word detection and voiceprint
 
+## Installation
+
+- Clone the repo
+``` sh
+git clone https://github.com/wenet-e2e/wenet.git
+```
+
+- Install Conda: please see https://docs.conda.io/en/latest/miniconda.html
+- Create Conda env:
+
+``` sh
+conda create -n wenet python=3.8
+conda activate wenet
+pip install -r requirements.txt
+conda install pytorch=1.10.0 torchaudio=0.10.0 cudatoolkit=11.1 -c pytorch -c conda-forge
+```
+
 ## Dataset
 
 We plan to support a variaty of open source wake-up word datasets, include but not limited to:
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..b010971
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,4 @@
+flake8==3.8.2
+pyyaml>=5.1
+tensorboard
+tensorboardX