diff options
| -rw-r--r-- | README.md | 13 | ||||
| -rw-r--r-- | doc/nerv.md | 3 |
2 files changed, 16 insertions, 0 deletions
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 diff --git a/doc/nerv.md b/doc/nerv.md new file mode 100644 index 0000000..3f544b1 --- /dev/null +++ b/doc/nerv.md @@ -0,0 +1,3 @@ +#The Nerv Package# +Part of the [Nerv](../README.md) toolkit. +##Methods##
\ No newline at end of file |