Repository: incubator-singa Updated Branches: refs/heads/dev 95091dcb6 -> a18a01907
SINGA-225 Documentation for installation and Cifar10 example Update the Readme of dev branch. Project: http://git-wip-us.apache.org/repos/asf/incubator-singa/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-singa/commit/a18a0190 Tree: http://git-wip-us.apache.org/repos/asf/incubator-singa/tree/a18a0190 Diff: http://git-wip-us.apache.org/repos/asf/incubator-singa/diff/a18a0190 Branch: refs/heads/dev Commit: a18a01907d3e43809e4d28129b550d2a605154eb Parents: 95091dc Author: wangwei <[email protected]> Authored: Sat Jul 16 13:36:41 2016 +0800 Committer: wangwei <[email protected]> Committed: Sat Jul 16 13:36:41 2016 +0800 ---------------------------------------------------------------------- README.md | 9 +++------ doc/Readme.md | 3 --- doc/develop/contribute-docs.md | 16 +++++++++++----- doc/downloads.md | 2 +- 4 files changed, 15 insertions(+), 15 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/a18a0190/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 55ec3cc..07acd68 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,12 @@ Distributed deep learning system -This is the dev branch for V1.0, please refer to the master branch and the following links for V0.3. +This is the dev branch for V1.0, please refer to the following docs for compilation and examples -##Project Website - -All the details can be found in [Project Website](http://singa.incubator.apache.org), including the following instructions. +* [Compilation](doc/docs/installation.md) +* [CNN example](doc/docs/cnn.md) ##Mailing Lists * [Development Mailing List](mailto:[email protected]) ([Archive](http://mail-archives.apache.org/mod_mbox/singa-dev/)) * [Commits Mailing List](mailto:[email protected]) ([Archive](http://mail-archives.apache.org/mod_mbox/singa-commits/)) - - http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/a18a0190/doc/Readme.md ---------------------------------------------------------------------- diff --git a/doc/Readme.md b/doc/Readme.md deleted file mode 100644 index bb7af20..0000000 --- a/doc/Readme.md +++ /dev/null @@ -1,3 +0,0 @@ -To generate docs, run "doxygen" in the this directory. - -Doxygen >= 1.8 recommended http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/a18a0190/doc/develop/contribute-docs.md ---------------------------------------------------------------------- diff --git a/doc/develop/contribute-docs.md b/doc/develop/contribute-docs.md index 3b8f483..5e21a0f 100644 --- a/doc/develop/contribute-docs.md +++ b/doc/develop/contribute-docs.md @@ -1,18 +1,20 @@ -## How to Contribute Documentation +# How to Contribute Documentation ___ + +## Website This document gives step-by-step instructions for deploying [Singa website](http://singa.incubator.apache.org). -Singa website is built by [Sphinx](http://www.sphinx-doc.org) 1.4.4 from a source tree stored in git: https://github.com/apache/incubator-singa/tree/master/doc. +Singa website is built by [Sphinx](http://www.sphinx-doc.org) 1.4.4 from a source tree stored in git: https://github.com/apache/incubator-singa/tree/master/doc. -To install Sphinx on Ubuntu: +To install Sphinx on Ubuntu: $ apt-get install python-sphinx -To install the markdown support for Sphinx: +To install the markdown support for Sphinx: - $ pip install recommonmark + $ pip install recommonmark You can build the website by executing the following command from the doc folder: @@ -20,3 +22,7 @@ You can build the website by executing the following command from the doc folder The procedure for contributing documentation is the same as [contributing code](contribute-code.html). + +## CPP API + +To generate docs, run "doxygen" from the doc folder (Doxygen >= 1.8 recommended) http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/a18a0190/doc/downloads.md ---------------------------------------------------------------------- diff --git a/doc/downloads.md b/doc/downloads.md index e54af36..31e7274 100644 --- a/doc/downloads.md +++ b/doc/downloads.md @@ -1,7 +1,7 @@ ## Download SINGA --- -* Latest code: please clone the latest code from [Github](https://github.com/apache/incubator-singa) +* Latest code: please clone the dev branch from [Github](https://github.com/apache/incubator-singa) * v0.3.0 (20 April 2016): * [Apache SINGA 0.3.0](http://www.apache.org/dyn/closer.cgi/incubator/singa/0.3.0/apache-singa-incubating-0.3.0.tar.gz)
