diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 8 |
1 files changed, 4 insertions, 4 deletions
@@ -1,9 +1,9 @@ -#The Nerv Toolkit User Manual# +# The Nerv Toolkit User Manual NOTE: This readme is obsolete and will be rearranged, for further information, please check http://nerv-sjtu.github.io/nerv/ This user manual will information about how to use __Nerv__ and __Nerv__'s interface. -##How to make and start using## +## How to make and start using First make sure you have __lua__ and __CUDA__ installed on your computer. __Nerv__ is currently developed via github.You can download and make __Nerv__ by doing the following: ``` @@ -29,11 +29,11 @@ You need to be at or (copy files from) `/slfs1`(SJTU speechlab cluster) to get t ./install/bin/nerv nerv/examples/asr_trainer.lua nerv/examples/swb_baseline.lua ``` -##How to contribute## +## How to contribute Fork the original repository, then use the __pull&merge__ function in github to contribute. The pull&merge request can be found on your dashboard in github. See this [sync-help] to sync with the original repository. -##Nerv Packages## +## Nerv Packages * __luaT__ Nerv uses [luaT]\(a [Torch] library\) to define lua class in C. * __[The Nerv OOP](nerv/doc/nerv_class.md)__ |