Skip to content

Commit 291c5fb

Browse files
committed
Readme: remove kofi badge and change install order
1 parent f5f0f4e commit 291c5fb

1 file changed

Lines changed: 14 additions & 14 deletions

File tree

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,12 @@
22
[![BuildStatus](https://travis-ci.com/laszukdawid/PyEMD.png?branch=master)](https://travis-ci.org/laszukdawid/PyEMD)
33
[![DocStatus](https://readthedocs.org/projects/pyemd/badge/?version=latest)](https://pyemd.readthedocs.io/)
44
[![Codacy](https://api.codacy.com/project/badge/Grade/5385d5ddc8e84908bd4e38f325443a21)](https://www.codacy.com/app/laszukdawid/PyEMD?utm_source=github.com&utm_medium=referral&utm_content=laszukdawid/PyEMD&utm_campaign=badger)
5-
[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/A0A110NUD)
65

76
# PyEMD
87

98
## Links
109

11-
- HTML documentation: <https://pyemd.readthedocs.org>
10+
- Online documentation: <https://pyemd.readthedocs.org>
1211
- Issue tracker: <https://github.com/laszukdawid/pyemd/issues>
1312
- Source code repository: <https://github.com/laszukdawid/pyemd>
1413

@@ -44,25 +43,26 @@ and extrema interpolation.
4443

4544
## Installation
4645

47-
### Recommended
46+
### PyPi (recommended)
4847

49-
Simply download this directory either directly from GitHub, or using
50-
command line:
48+
The quickest way to install package is through `pip`.
5149

52-
> \$ git clone <https://github.com/laszukdawid/PyEMD>
50+
> \$ pip install EMD-signal
5351
54-
Then go into the downloaded project and run from command line:
52+
### From source
5553

56-
> \$ python setup.py install
54+
In case you only want to *use* EMD and its variation, the best way to install PyEMD is through `pip`.
55+
However, if you are want to modify the code anyhow you might want to download the code and build package yourself.
56+
The source is publicaly available and hosted on [GitHub](https://github.com/laszukdawid/PyEMD).
57+
To download the code you can either go to the source code page and click `Code -> Download ZIP`, or use **git** command line
5758

58-
### PyPi
59+
> \$ git clone <https://github.com/laszukdawid/PyEMD>
5960
60-
Packaged obtained from PyPi is/will be slightly behind this project, so
61-
some features might not be the same. However, it seems to be the
62-
easiest/nicest way of installing any Python packages, so why not this
63-
one?
61+
Installing package from source is done using command line:
6462

65-
> \$ pip install EMD-signal
63+
> \$ python setup.py install
64+
65+
**Note**, however, that this will install it in your current environment. If you are working on many projects, or sharing reources with others, we suggest using [virtual environments](https://docs.python.org/3/library/venv.html).
6666

6767
## Example
6868

0 commit comments

Comments
 (0)