You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@singa.apache.org by wa...@apache.org on 2015/05/07 15:08:19 UTC
[55/57] incubator-singa git commit: add instructions for preview on
github
add instructions for preview on github
Project: http://git-wip-us.apache.org/repos/asf/incubator-singa/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-singa/commit/3a891c27
Tree: http://git-wip-us.apache.org/repos/asf/incubator-singa/tree/3a891c27
Diff: http://git-wip-us.apache.org/repos/asf/incubator-singa/diff/3a891c27
Branch: refs/heads/gh-pages
Commit: 3a891c277b42bd6ed202616b4ae6d5d2512394e4
Parents: 6a79132
Author: wang wei <wa...@comp.nus.edu.sg>
Authored: Thu May 7 20:39:03 2015 +0800
Committer: wang wei <wa...@comp.nus.edu.sg>
Committed: Thu May 7 20:39:03 2015 +0800
----------------------------------------------------------------------
README.md | 32 +++++++++++
_posts/docs/2015-01-20-installation.md | 85 +++++++++++++++++++++++++++++
2 files changed, 117 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/3a891c27/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 30b6805..006e40c 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,40 @@
## Edit and Preview the Website
+All documentations are written in Markdown format and located at _posts/.
+
+### Preview locally
+
+If you have installed Jekyll, then you can preview the website by
+
jekyll serve --config _config.yml,_config-prod.yml
+### Preview on your own Github site
+
+If you do not have Jekyll installed on your own computer, then your can follow
+these steps to preview the website on you own Github site:
+
+ * fork SINGA to your own Github account from [https://github.com/apache/incubator-singa](https://github.com/apache/incubator-singa).
+ * clone SINGA from your Github to your local computer
+ * edit the content (e.g., add documentations)
+ * update the BASE_URL in _config.yml to "http://username.github.io/incubator-singa"
+ * commit and push to your own Github repo
+ * goto http://username.github.io/incubator-singa/
+
+## Submit to the Incubator-Singa repo
+
+After finishing updating the website, commiters can submit their commits as
+follows.
+**Make sure that you have changed back the BASE_URL to "/singa" if you have previewed.**
+it on your own Github site.
+
+ # done only once
+ git add upstream git://git.apache.org/incubator-singa.git
+
+ # done for every submit
+ git push upstream gh-pages
+
## License
+
* We used Jekyll-Boostrap [MIT](http://opensource.org/licenses/MIT) to generate this website.
* The source code except that from Jekyll-Boostrap is release under
[Apache License 2](http://www.apache.org/licenses/LICENSE-2.0.html).
http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/3a891c27/_posts/docs/2015-01-20-installation.md
----------------------------------------------------------------------
diff --git a/_posts/docs/2015-01-20-installation.md b/_posts/docs/2015-01-20-installation.md
index bdc1b28..b34b534 100644
--- a/_posts/docs/2015-01-20-installation.md
+++ b/_posts/docs/2015-01-20-installation.md
@@ -6,4 +6,89 @@ tags : [installation, examples]
---
{% include JB/setup %}
+##Dependencies
+SINGA is developed and tested on Linux platforms with the following external libraries.
+
+ * gflags version 2.1.1, use the default setting for namespace (i.e., gflags).
+
+ * glog version 0.3.3.
+
+ * gtest version 1.7.0.
+
+ * google-protobuf version 2.6.0.
+
+ * openblas version >= 0.2.10.
+
+ * opencv version 2.4.9.
+
+ * zeromq version >= 3.2
+
+ * czmq version >= 3
+
+Tips:
+For libraries like openblas, opencv, older versions may also work, because we do not use any newly added features.
+
+
+##Building SINGA From Source
+
+The build system of SINGA is based on GNU autotools. To build singa, you need gcc version >= 4.8.
+The common steps to build SINGA can be:
+
+ 1.Extract source files;
+ 2.Run configure script to generate makefiles;
+ 3.Build and install SINGA.
+
+On Unix-like systems with GNU Make as build tool, these build steps can be summarized by the following sequence of commands executed in a shell.
+
+ $ cd SINGA/FOLDER
+ $ ./configure
+ $ make
+ $ make install
+
+After executing above commands, SINGA library will be installed in the system default directory.
+If you want to specify your own installation directory, use the following command instead.
+
+ $ ./configure --prefix=/YOUR/OWN/FOLDER
+
+The result of configure script will indicate you whether there exist dependency missings in your system.
+If you do not install the dependencies, you can run the following commands.
+To download the thirdparty dependencies:
+
+ $ ./script/download.sh
+
+After downloading, to install the thirdparty dependencies:
+
+ $ cd thirdparty
+ $ ./install-dependencies.sh MISSING_LIBRARY_NAME1 YOUR_INSTALL_PATH1 MISSING_LIBRARY_NAME2 YOUR_INSTALL_PATH2 ...
+
+If you do not specify the installation path, the library will be installed in default folder.
+For example, if you want to build zeromq library in system folder and gflags in /usr/local, just run:
+
+ $ ./install-dependencies.sh zeromq gflags /usr/local
+
+Another example can be to install all dependencies in /usr/local directory:
+
+ $ ./install-dependencies.sh all /usr/local
+
+Here is a table showing the first arguments:
+
+ MISSING_LIBRARY_NAME LIBRARIES
+ cmake cmake tools
+ czmq* czmq lib
+ gflags gflags lib
+ glog glog lib
+ lmdb lmdb lib
+ OpenBLAS OpenBLAS lib
+ opencv OpenCV
+ protobuf Google protobuf
+ zeromq zeromq lib
+
+*: Since czmq depends on zeromq, the script offers you one more argument to indicate zeromq location.
+The installation commands of czmq can be:
+
+ $./install-dependencies.sh czmq /usr/local /usr/local/zeromq
+
+After the execution, czmq will be installed in /usr/local while zeromq is installed in /usr/local/zeromq.
+
+## FAQ