From d0bf4368e7c4c60966cabc8bc07a3ec7d3aa0d80 Mon Sep 17 00:00:00 2001 From: cloudygoose Date: Fri, 29 May 2015 16:15:43 +0800 Subject: README added --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..465fa29 --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +#The Nerv Toolkit User Manual# +This user manual will provide information about Nerv's interface. + +##Nerv Packages## +* __luaT__ +Nerv uses [luaT]\(a [Torch] library\) to define lua class in C. +* __[Nerv](doc/nerv.md)__ +Inlcudes some utility functions from luaT to implement __Nerv.Class__. +* __Nerv.Matrix__ +__Nerv.Matrix__ is a basic class 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 -- cgit v1.2.3 From 240cc240f0c5d7f0691febfb0aedc61d00291dad Mon Sep 17 00:00:00 2001 From: cloudygoose Date: Fri, 29 May 2015 16:20:57 +0800 Subject: ... --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 465fa29..60bd21f 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ #The Nerv Toolkit User Manual# -This user manual will provide information about Nerv's interface. +This user manual will information about how to use __Nerv__ and __Nerv__'s interface. ##Nerv Packages## -* __luaT__ +* __luaT__ Nerv uses [luaT]\(a [Torch] library\) to define lua class in C. -* __[Nerv](doc/nerv.md)__ +* __[The Nerv utility functions](doc/nerv.md)__ Inlcudes some utility functions from luaT to implement __Nerv.Class__. -* __Nerv.Matrix__ -__Nerv.Matrix__ is a basic class in __Nerv__ that is used to store and manipulate matrices. +* __The Nerv Matrix Package__ +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 -- cgit v1.2.3 From e991ad1e5153d23a8ae38110e3093b88e058140a Mon Sep 17 00:00:00 2001 From: cloudygoose Date: Fri, 29 May 2015 17:16:24 +0800 Subject: modified documentation for nerv utility --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 60bd21f..54d0218 100644 --- a/README.md +++ b/README.md @@ -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 -- cgit v1.2.3