summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorZader Zheng <[email protected]>2016-02-28 12:34:26 +0800
committerZader Zheng <[email protected]>2016-02-28 12:34:26 +0800
commita3a606ddc91077064e8799c4bf4efe862f38e314 (patch)
tree2628dbd0eccb28836a0e23f9e3c1da7146cfc7e3 /README.md
parent550680eacd00555817df19d2b59a20a92df77c42 (diff)
change to standard markdown title syntax to fit GitLab doc preview
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/README.md b/README.md
index fe9dfc1..d3843c9 100644
--- a/README.md
+++ b/README.md
@@ -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)__