summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorcloudygoose <[email protected]>2015-05-31 11:35:32 +0800
committercloudygoose <[email protected]>2015-05-31 11:35:32 +0800
commit29535cd402af7eaf8be7b48620826fc82591a010 (patch)
treee76cc34b07152bb5970e2e46b660ba1c01c4e59d
parent36162328956177d554891f937a13616b5476b231 (diff)
doc change
-rw-r--r--README.md4
-rw-r--r--doc/nerv_class.md3
2 files changed, 6 insertions, 1 deletions
diff --git a/README.md b/README.md
index 54d0218..27e0d3e 100644
--- a/README.md
+++ b/README.md
@@ -24,6 +24,8 @@ The pull&merge request can be found on your dashboard in github. See this [sync-
##Nerv Packages##
* __luaT__
Nerv uses [luaT]\(a [Torch] library\) to define lua class in C.
+* __[The Nerv OOP](doc/nerv_class.md)__
+Enables object-oriented programming in Nerv.
* __[The Nerv utility functions](doc/nerv.md)__
Inlcudes some utility functions from luaT to implement __Nerv.Class__.
* __The Nerv Matrix Package__
@@ -31,4 +33,4 @@ The Matrix package is a basic package in __Nerv__ that is used to store and mani
[luaT]:https://github.com/torch/torch7/tree/master/lib/luaT
[Torch]:https://github.com/torch
-[sync-help]:https://help.github.com/articles/syncing-a-fork/ \ No newline at end of file
+[sync-help]:https://help.github.com/articles/syncing-a-fork/
diff --git a/doc/nerv_class.md b/doc/nerv_class.md
new file mode 100644
index 0000000..3c3d09e
--- /dev/null
+++ b/doc/nerv_class.md
@@ -0,0 +1,3 @@
+#The Nerv OOP#
+Part of the [Nerv](../README.md) toolkit.
+##Methods##