diff --git a/README.md b/README.md index d2d7f138e26e..647e0f02d093 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,15 @@ # MXNet -This is an experimental project to put cxxnet and minerva together, nothing is working yet. +This is a project that combines lessons and ideas we learnt from [cxxnet](https://github.com/dmlc/cxxnet), [minerva](https://github.com/dmlc/minerva) and [purine2](https://github.com/purine/purine2). +- The interface is designed in collaboration by authors of three projects. +- Nothing is yet working # Guidelines * Use google c style * Put module header in [include](include) - - move them to ```project-name/include``` when we finalized the name * Depend on [dmlc-core](https://github.com/dmlc/dmlc-core) * Doxygen comment every function, class and variable for the module headers - Ref headers in [dmlc-core/include](https://github.com/dmlc/dmlc-core/tree/master/include/dmlc) - Use the same style as dmlc-core -* Try write some use-cases of interface in [test](test) - - They do not need to link, but need to pass compile * Minimize dependency, if possible only depend on dmlc-core * Macro Guard CXX11 code by - Try to make interface compile when c++11 was not avaialable(but with some functionalities pieces missing)