Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
aksnzhy committed Dec 9, 2017
1 parent 15ceef7 commit c424c57
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 7 deletions.
Binary file modified _build/doctrees/environment.pickle
Binary file not shown.
Binary file modified _build/doctrees/install.doctree
Binary file not shown.
6 changes: 4 additions & 2 deletions _build/html/_sources/install.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Building xLearn from source code consists two steps:
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.

Then, install the python package.
Then, you can install the python package through ``install-python.sh``.

Fortunately, we write a script ``build.sh`` to do all the things for users.

Expand All @@ -47,10 +47,12 @@ and then build xLearn using the folloing commands ::
cd xlearn
./build.sh

The ``build.sh`` will build xLearn in ``build`` directory in current path.

Test
----------------------------------

Now you can test your building by using xLearn command line ::
Now you can test your installation by using the following xLearn command line ::

cd build
./run_example.sh
Expand Down
5 changes: 3 additions & 2 deletions _build/html/install.html
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ <h2>Install xLearn from Source Code<a class="headerlink" href="#install-xlearn-f
<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>Then, you can install the python package through <code class="docutils literal"><span class="pre">install-python.sh</span></code>.</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>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>
Expand All @@ -208,10 +208,11 @@ <h2>Install xLearn from Source Code<a class="headerlink" href="#install-xlearn-f
<span class="o">./</span><span class="n">build</span><span class="o">.</span><span class="n">sh</span>
</pre></div>
</div>
<p>The <code class="docutils literal"><span class="pre">build.sh</span></code> will build xLearn in <code class="docutils literal"><span class="pre">build</span></code> directory in current path.</p>
</div>
<div class="section" id="test">
<h2>Test<a class="headerlink" href="#test" title="Permalink to this headline"></a></h2>
<p>Now you can test your building by using xLearn command line</p>
<p>Now you can test your installation by using the following 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>
Expand Down
2 changes: 1 addition & 1 deletion _build/html/searchindex.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 4 additions & 2 deletions install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Building xLearn from source code consists two steps:
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.

Then, install the python package.
Then, you can install the python package through ``install-python.sh``.

Fortunately, we write a script ``build.sh`` to do all the things for users.

Expand All @@ -47,10 +47,12 @@ and then build xLearn using the folloing commands ::
cd xlearn
./build.sh

The ``build.sh`` will build xLearn in ``build`` directory in current path.

Test
----------------------------------

Now you can test your building by using xLearn command line ::
Now you can test your installation by using the following xLearn command line ::

cd build
./run_example.sh
Expand Down

0 comments on commit c424c57

Please sign in to comment.