Skip to content

Commit

Permalink
Updated suggested approaches for installation and testing in the docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
zakv committed Aug 31, 2021
1 parent 6ca72cb commit ce9b9fd
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
6 changes: 3 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ The Machine-Learner Online Optimization Package is designed to automatically and

To install M-LOOP simply run::

python setup.py develop
pip install -e <path_to_m-loop>

In the M-LOOP source folder.
Be sure to replace ``<path_to_m-loop>`` with the actual path to the M-LOOP repository's root directory.

For more details on how to use the package see the documentation. You can see it online at

Expand All @@ -18,7 +18,7 @@ Or you can build it by entering the docs folder and running::

make html

The docs can then be found in docs/_build/html
The docs can then be found in ``docs/_build/html``.

If you use M-LOOP please cite its first application:

Expand Down
8 changes: 4 additions & 4 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,10 @@ M-LOOP can be installed from the latest source code with three commands::

git clone git://github.com/michaelhush/M-LOOP.git
cd ./M-LOOP
python setup.py develop
pip install -e .

The first command downloads the latest source code for M-LOOP from GitHub into the current directory, the second moves into the M-LOOP source directory, and the third command builds the package and creates a link from you python package to the source.
If you are using linux or MacOS you may need admin privileges to run the setup script.
If you are using linux or MacOS you may need admin privileges to run the installation step.

At any time you can update M-LOOP to the latest version from GitHub by running the command::

Expand All @@ -70,9 +70,9 @@ If you are using linux or MacOS you may need admin privileges to run the command
Testing
=======

If you have installed from source, you can test your installation with the command::
If you have installed from source, you can test your installation by running the command::

python setup.py test
pytest
In the M-LOOP source code directory. The tests should take around five minutes to complete. If you find a error please consider :ref:`sec-contributing` to the project and report a bug on the `GitHub <https://github.com/michaelhush/M-LOOP>`_.

Expand Down

0 comments on commit ce9b9fd

Please sign in to comment.