update doc

_build/html/_sources/install.rst.txt

@@ -1,11 +1,11 @@
 Installation Guide
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-For now, xLearn can support Linux and Mac OSX. We will support it on Windows in 
+For now, xLearn can support Linux and Mac OSX. We will support it on Windows platform in 
 the near future. This page gives instructions on how to build and install the xLearn 
-package using pip, or from source code. Whatever way you choose, make sure that your 
-OS has already installed ``GCC`` (or ``Clang``) and ``CMake``, and your compiler need 
-to support ``C++11``. If you have not installed them, please see `this page`__ on how to 
+package using pip and how to build it from source code. No matter what way you choose, make 
+sure that your OS has already installed ``GCC`` (or ``Clang``) and ``CMake``, and your compiler 
+need to support ``C++11``. If you have not installed them, please see `this page`__ on how to 
 install GCC and CMake.
 
 Install xLearn from pip
@@ -26,19 +26,19 @@ If you want to build the lastest code from github, or you want to use the xLearn
 instead of the python API, you can see how to build xLearn from source code as follow.
 
 
-Install xLearn from source code
+Install xLearn from Source Code
 ----------------------------------
 
-Building xLearn from source code consists tow steps:
+Building xLearn from source code consists two steps:
 
-1. First, build the executable files (``learn_train`` and ``xlearn_predict``) and shared library (``libxlearn.so`` 
-for Linux and ``libxlearn.dylib`` for Mac OSX) from the C++ code.
+First, build the executable files (``xlearn_train`` and ``xlearn_predict``) and the shared library 
+(``libxlearn.so`` for Linux and ``libxlearn.dylib`` for Mac OSX) from the C++ code.
 
-2. Then, install the python package.
+Then, install the python package.
 
 Fortunately, we write a script ``build.sh`` to do all the things for users.
 
-First you need is to clone the code from github ::
+For users, you just need to clone the code from github ::
 
   git clone https://github.com/aksnzhy/xlearn.git
 
@@ -50,12 +50,11 @@ and then build xLearn using the folloing commands ::
 Test
 ----------------------------------
 
-Now you can check your building by using xlearn command line ::
+Now you can check your building by using xLearn command line ::
 
   cd build
   ./run_example.sh
 
-
 You can also test the python package by using ::
 
   cd python-package/test

_build/html/install.html

@@ -93,7 +93,7 @@
               <ul class="current">
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Installation Guide</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#install-xlearn-from-pip">Install xLearn from pip</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#install-xlearn-from-source-code">Install xLearn from source code</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#install-xlearn-from-source-code">Install xLearn from Source Code</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#test">Test</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="install_cmake.html">Install GCC or Clang</a></li>
 <li class="toctree-l3"><a class="reference internal" href="install_cmake.html#install-cmake">Install CMake</a></li>
@@ -170,11 +170,11 @@
 
   <div class="section" id="installation-guide">
 <h1>Installation Guide<a class="headerlink" href="#installation-guide" title="Permalink to this headline">¶</a></h1>
-<p>For now, xLearn can support Linux and Mac OSX. We will support it on Windows in
+<p>For now, xLearn can support Linux and Mac OSX. We will support it on Windows platform in
 the near future. This page gives instructions on how to build and install the xLearn
-package using pip, or from source code. Whatever way you choose, make sure that your
-OS has already installed <code class="docutils literal"><span class="pre">GCC</span></code> (or <code class="docutils literal"><span class="pre">Clang</span></code>) and <code class="docutils literal"><span class="pre">CMake</span></code>, and your compiler need
-to support <code class="docutils literal"><span class="pre">C++11</span></code>. If you have not installed them, please see <a class="reference external" href="install_cmake.html">this page</a> on how to
+package using pip and how to build it from source code. No matter what way you choose, make
+sure that your OS has already installed <code class="docutils literal"><span class="pre">GCC</span></code> (or <code class="docutils literal"><span class="pre">Clang</span></code>) and <code class="docutils literal"><span class="pre">CMake</span></code>, and your compiler
+need to support <code class="docutils literal"><span class="pre">C++11</span></code>. If you have not installed them, please see <a class="reference external" href="install_cmake.html">this page</a> on how to
 install GCC and CMake.</p>
 <div class="section" id="install-xlearn-from-pip">
 <h2>Install xLearn from pip<a class="headerlink" href="#install-xlearn-from-pip" title="Permalink to this headline">¶</a></h2>
@@ -193,15 +193,13 @@ <h2>Install xLearn from pip<a class="headerlink" href="#install-xlearn-from-pip"
 instead of the python API, you can see how to build xLearn from source code as follow.</p>
 </div>
 <div class="section" id="install-xlearn-from-source-code">
-<h2>Install xLearn from source code<a class="headerlink" href="#install-xlearn-from-source-code" title="Permalink to this headline">¶</a></h2>
-<p>Building xLearn from source code consists tow steps:</p>
-<p>1. First, build the executable files (<code class="docutils literal"><span class="pre">learn_train</span></code> and <code class="docutils literal"><span class="pre">xlearn_predict</span></code>) and shared library (<code class="docutils literal"><span class="pre">libxlearn.so</span></code>
-for Linux and <code class="docutils literal"><span class="pre">libxlearn.dylib</span></code> for Mac OSX) from the C++ code.</p>
-<ol class="arabic simple" start="2">
-<li>Then, install the python package.</li>
-</ol>
+<h2>Install xLearn from Source Code<a class="headerlink" href="#install-xlearn-from-source-code" title="Permalink to this headline">¶</a></h2>
+<p>Building xLearn from source code consists two steps:</p>
+<p>First, build the executable files (<code class="docutils literal"><span class="pre">xlearn_train</span></code> and <code class="docutils literal"><span class="pre">xlearn_predict</span></code>) and the shared library
+(<code class="docutils literal"><span class="pre">libxlearn.so</span></code> for Linux and <code class="docutils literal"><span class="pre">libxlearn.dylib</span></code> for Mac OSX) from the C++ code.</p>
+<p>Then, install the python package.</p>
 <p>Fortunately, we write a script <code class="docutils literal"><span class="pre">build.sh</span></code> to do all the things for users.</p>
-<p>First you need is to clone the code from github</p>
+<p>For users, you just need to clone the code from github</p>
 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">aksnzhy</span><span class="o">/</span><span class="n">xlearn</span><span class="o">.</span><span class="n">git</span>
 </pre></div>
 </div>
@@ -213,7 +211,7 @@ <h2>Install xLearn from source code<a class="headerlink" href="#install-xlearn-f
 </div>
 <div class="section" id="test">
 <h2>Test<a class="headerlink" href="#test" title="Permalink to this headline">¶</a></h2>
-<p>Now you can check your building by using xlearn command line</p>
+<p>Now you can check your building by using xLearn command line</p>
 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">build</span>
 <span class="o">./</span><span class="n">run_example</span><span class="o">.</span><span class="n">sh</span>
 </pre></div>

install.rst

@@ -1,11 +1,11 @@
 Installation Guide
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-For now, xLearn can support Linux and Mac OSX. We will support it on Windows in 
+For now, xLearn can support Linux and Mac OSX. We will support it on Windows platform in 
 the near future. This page gives instructions on how to build and install the xLearn 
-package using pip, or from source code. Whatever way you choose, make sure that your 
-OS has already installed ``GCC`` (or ``Clang``) and ``CMake``, and your compiler need 
-to support ``C++11``. If you have not installed them, please see `this page`__ on how to 
+package using pip and how to build it from source code. No matter what way you choose, make 
+sure that your OS has already installed ``GCC`` (or ``Clang``) and ``CMake``, and your compiler 
+need to support ``C++11``. If you have not installed them, please see `this page`__ on how to 
 install GCC and CMake.
 
 Install xLearn from pip
@@ -26,19 +26,19 @@ If you want to build the lastest code from github, or you want to use the xLearn
 instead of the python API, you can see how to build xLearn from source code as follow.
 
 
-Install xLearn from source code
+Install xLearn from Source Code
 ----------------------------------
 
-Building xLearn from source code consists tow steps:
+Building xLearn from source code consists two steps:
 
-1. First, build the executable files (``learn_train`` and ``xlearn_predict``) and shared library (``libxlearn.so`` 
-for Linux and ``libxlearn.dylib`` for Mac OSX) from the C++ code.
+First, build the executable files (``xlearn_train`` and ``xlearn_predict``) and the shared library 
+(``libxlearn.so`` for Linux and ``libxlearn.dylib`` for Mac OSX) from the C++ code.
 
-2. Then, install the python package.
+Then, install the python package.
 
 Fortunately, we write a script ``build.sh`` to do all the things for users.
 
-First you need is to clone the code from github ::
+For users, you just need to clone the code from github ::
 
   git clone https://github.com/aksnzhy/xlearn.git
 
@@ -50,12 +50,11 @@ and then build xLearn using the folloing commands ::
 Test
 ----------------------------------
 
-Now you can check your building by using xlearn command line ::
+Now you can check your building by using xLearn command line ::
 
   cd build
   ./run_example.sh
 
-
 You can also test the python package by using ::
 
   cd python-package/test