You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mxnet.apache.org by jx...@apache.org on 2017/08/29 03:10:45 UTC
[incubator-mxnet] branch master updated: Doc updates for install
and doc generation (#7647)
This is an automated email from the ASF dual-hosted git repository.
jxie pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-mxnet.git
The following commit(s) were added to refs/heads/master by this push:
new 18c4eee Doc updates for install and doc generation (#7647)
18c4eee is described below
commit 18c4eee7a6e82484a441526f4f7723223b162b1f
Author: Hagay Lupesko <lu...@users.noreply.github.com>
AuthorDate: Mon Aug 28 20:10:43 2017 -0700
Doc updates for install and doc generation (#7647)
---
docs/README.md | 4 ++--
docs/get_started/install.md | 10 ++++++----
2 files changed, 8 insertions(+), 6 deletions(-)
diff --git a/docs/README.md b/docs/README.md
index 7780f89..8fd0592 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -7,7 +7,7 @@ Then use the following commands to clone and
build the documents.
```bash
-git clone --recursive https://github.com/dmlc/mxnet
+git clone --recursive https://github.com/apache/incubator-mxnet.git
cd mxnet && make docs
```
@@ -17,6 +17,6 @@ Note:
- If C++ codes have been changed, we suggest to remove the previous results to
trigger the rebuild for all pages, namely run `make clean_docs`.
-- If C++ codes are failed to build, run `make clean`
+- If C++ code fails to build, run `make clean`
- If CSS or javascript are changed, we often need to do a *force refresh* in the
browser to clear the cache.
diff --git a/docs/get_started/install.md b/docs/get_started/install.md
index 65126a5..0072e3c 100644
--- a/docs/get_started/install.md
+++ b/docs/get_started/install.md
@@ -506,10 +506,6 @@ pip install graphviz
The following installation instructions have been tested on OSX Sierra and El Capitan.
-**Prerequisites**
-
-If not already installed, [download and install Xcode](https://developer.apple.com/xcode/) (or [insall it from the App Store](https://itunes.apple.com/us/app/xcode/id497799835)) for macOS. [Xcode](https://en.wikipedia.org/wiki/Xcode) is an integrated development environment for macOS containing a suite of software development tools like C/C++ compilers, BLAS library and more.
-
<div class="virtualenv">
<br/>
@@ -645,6 +641,12 @@ mxnet/python latest 00d026968b3c 3 weeks ago
<div class="build-from-source">
<br/>
+**Prerequisites**
+
+If not already installed, [download and install Xcode](https://developer.apple.com/xcode/) (or [insall it from the App Store](https://itunes.apple.com/us/app/xcode/id497799835)) for macOS. [Xcode](https://en.wikipedia.org/wiki/Xcode) is an integrated development environment for macOS containing a suite of software development tools like C/C++ compilers, BLAS library and more.
+
+<br/>
+
Building *MXNet* from source is a 2 step process.
1. Build the *MXNet* core shared library, `libmxnet.so`, from the C++ sources.
2. Build the language specific bindings. Example - Python bindings, Scala bindings.
--
To stop receiving notification emails like this one, please contact
['"commits@mxnet.apache.org" <co...@mxnet.apache.org>'].