aboutsummaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorDeterminant <ted.sybil@gmail.com>2016-06-08 14:35:57 +0800
committerDeterminant <ted.sybil@gmail.com>2016-06-08 14:35:57 +0800
commitb7cdd5da65a3e4ae58ffcfdf74710cfb1ee6327f (patch)
tree26f9d18391450052d7d1c99262761b1bee510672 /README.rst
parentd88a57f4852c50a2678de950ee650ed9b6a895f0 (diff)
add more doc
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst20
1 files changed, 14 insertions, 6 deletions
diff --git a/README.rst b/README.rst
index 5e04a07..7f101af 100644
--- a/README.rst
+++ b/README.rst
@@ -8,14 +8,20 @@ Installation
First, make sure you have at least one implementation of BLAS and CUDA installed
on your computer.
-- Checkout NERV:
+- Clone NERV:
::
bash
git clone https://speechlab.sjtu.edu.cn/gitlab/nerv-dev/nerv.git
-- Checkout submodules (luajit, luarocks, Penlight, etc.):
+- Checkout the latest tagged version (please change the tag name to the
+ latest):
+
+ ::
+ git checkout beta-1.21
+
+- Download submodules (luajit, LuaRocks, Penlight, etc.):
::
@@ -43,9 +49,10 @@ on your computer.
::
- # checkout speech repository to local directory nerv/speech (suppose you're
- # still at the root directory of NERV repo)
+ # clone and checkout speech repository to local directory nerv/speech
+ # (suppose you're still at the root directory of NERV repo)
git clone https://speechlab.sjtu.edu.cn/gitlab/nerv-dev/nerv-speech.git speech
+ git checkout beta-1.21 # please change the tag name to the latest
# build and install HTK I/O support, Kaldi I/O support, Kaldi decoding support, etc.
make speech BLAS_TYPE=mkl BLAS_BASE=/home/intel/mkl/lib/intel64/ KALDI_BASE=/speechlab/tools/KALDI/kaldi-master/
@@ -60,5 +67,6 @@ request (merge request) to the administrator of the project. If you want to fix
any bugs in existing code, don't hesitate to create a pull (merge) request to
the repository with clear and detailed analysis of the problem. If you want to
add additional task-specific functionalities (modules) for speech to NERV,
-please create a luarocks-compliant package and also a pull (merge) request to
-the ``nerv-speech`` repository instead of ``nerv``.
+please create a LuaRocks-compliant package and also a pull (merge) request to
+the ``nerv-speech`` repository instead of ``nerv``. Please refer to the
+collaboration rules in NERV's doc.