diff options
| author | cloudygoose <[email protected]> | 2015-05-29 17:16:24 +0800 |
|---|---|---|
| committer | cloudygoose <[email protected]> | 2015-05-29 17:16:24 +0800 |
| commit | e991ad1e5153d23a8ae38110e3093b88e058140a (patch) | |
| tree | c156248f222c4c0d747787fdc4677cf42ba96ddc | |
| parent | 240cc240f0c5d7f0691febfb0aedc61d00291dad (diff) | |
modified documentation for nerv utility
| -rw-r--r-- | README.md | 23 | ||||
| -rw-r--r-- | doc/nerv.md | 6 |
2 files changed, 26 insertions, 3 deletions
@@ -1,6 +1,26 @@ #The Nerv Toolkit User Manual# This user manual will information about how to use __Nerv__ and __Nerv__'s interface. +##How to use## +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: +``` +cd ~ +git clone https://github.com/Determinant/nerv.git +cd nerv +git submodule init && git submodule update +make +``` +The `git submodule` command is for the __luajit__ repository inside __Nerv__. +Now, you can try to run some example scripts. +``` +./nerv examples/cumatrix_example.lua +``` + +##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## * __luaT__ Nerv uses [luaT]\(a [Torch] library\) to define lua class in C. @@ -10,4 +30,5 @@ Inlcudes some utility functions from luaT to implement __Nerv.Class__. The Matrix package is a basic package in __Nerv__ that is used to store and manipulate matrices. [luaT]:https://github.com/torch/torch7/tree/master/lib/luaT -[Torch]:https://github.com/torch
\ No newline at end of file +[Torch]:https://github.com/torch +[sync-help]:https://help.github.com/articles/syncing-a-fork/
\ No newline at end of file diff --git a/doc/nerv.md b/doc/nerv.md index 3f544b1..b6631a6 100644 --- a/doc/nerv.md +++ b/doc/nerv.md @@ -1,3 +1,5 @@ -#The Nerv Package# +#The Nerv utility functions# Part of the [Nerv](../README.md) toolkit. -##Methods##
\ No newline at end of file +##Methods## +* __string = nerv.setmetatable(table self, string tname)__ +A registered function, the original function is `luaT_lua_setmetatable`. It assigns the metatable registered in __luaT__ by the name *tname* to the table *self*. And return *tname* to user. |