Skip to content

Commit

Permalink
Update readme to reflect new conda instructions and use of pytest
Browse files Browse the repository at this point in the history
  • Loading branch information
patricksnape committed Jan 2, 2020
1 parent 334fb3d commit c007194
Showing 1 changed file with 8 additions and 10 deletions.
18 changes: 8 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,18 +48,15 @@ package management system, `pip`, then you should be able to install
Menpo as follows:

```
> pip install cython numpy
> pip install menpo
```

However, this may be difficult to achieve on platforms such as Windows where
a compiler would need to be correctly configured. Therefore, we strongly
advocate the use of [conda](http://conda.pydata.org/docs/) which does
not require compilation for installing Menpo (or Numpy, SciPy or Matplotlib
for that matter). Installation via `conda` is as simple as
We strongly advocate the use of [conda](http://conda.pydata.org/docs/) which does
not require compilation for installing Menpo or it's dependencies such as Numpy,
SciPy or Matplotlib. Installation via `conda` is as simple as

```
> conda install -c menpo menpo
> conda install -c conda-forge menpo
```

#### Build Status
Expand Down Expand Up @@ -126,11 +123,11 @@ See our documentation on [ReadTheDocs](http://menpo.readthedocs.org)

Testing
-------
We use [nose](https://nose.readthedocs.org/en/latest/) for unit tests.
We use [pytest](http://pytest.org/en/latest/) for unit tests.

After installing `nose` and `mock`, running
After installing `pytest`, `mock` and `pytest-mock`, running

>> nosetests .
>> pytest .

from the top of the repository will run all of the unit tests.

Expand All @@ -139,4 +136,5 @@ dependency installed. These are:

- 3D viewing methods, only available if `menpo3d` is installed
- `menpo.feature.dsift` only available if `cyvlfeat` is installed
- Some warping unit tests are only available if `opencv` is installed
- Widgets are only available if `menpowidgets` is installed

0 comments on commit c007194

Please sign in to comment.