Update README.md #155
Update README.md #155
Conversation
Fixed pip command for installation from source
fixed instruction for installation from sources
There was a problem hiding this comment.
Thanks for suggestions; they're very good and fitting :) However, to merge this, I'd ask to rephrase or delete the "the old" sentence. The main branch might not always "stable" and for most folks I'd strongly encourage installing only the pypi packages. And, those who know that it's possible to install from github directly they might also know about the difference between released and 'main' version. Besides, there's a build job on the merge to main, that whenever version changes it publishes a new package to pypi.
| @@ -56,6 +56,8 @@ The quickest way to install package is through `pip`. | |||
|
|
|||
| > \$ pip install EMD-signal | |||
|
|
|||
| In this way you install the old version of PyEMD hosted on PyPi | |||
|
|
|||
There was a problem hiding this comment.
The wording of this sentence isn't correct. For one, it is the latest officially supported version rather than "the old". If feel strongly that there needs to be an explanation that this package is hosted on pypi then please reprahse it. Otherwise, I think this sentence doesn't add much to the doc and can be deleted.
There was a problem hiding this comment.
I'll fix the sentence and adjust the paragraph to improve the consistency of the instruction for the installation from source
There was a problem hiding this comment.
I'll fix the sentence and adjust the paragraph to improve the consistency of the instruction for the installation from source
Done
There was a problem hiding this comment.
Sorry, was traveling. Looks good!
| @@ -67,7 +69,13 @@ To download the code you can either go to the source code page and click `Code - | |||
|
|
|||
| Installing package from source is done using command line: | |||
|
|
|||
| > \$ python setup.py install | |||
| > \$ python3 -m pip install . | |||
There was a problem hiding this comment.
Good point! Thank you for point out that setup hasn't been supported for a while.
Fixed wrong wording
| @@ -56,6 +56,8 @@ The quickest way to install package is through `pip`. | |||
|
|
|||
| > \$ pip install EMD-signal | |||
|
|
|||
| In this way you install the old version of PyEMD hosted on PyPi | |||
|
|
|||
There was a problem hiding this comment.
Sorry, was traveling. Looks good!
Fixed pip command for installation from source.
The modification is necessary because in the master branch there is no "setup.py" file, making your previous command useless.
Giving to
pipthe path for the packagepip install .will install the PyEMD package from the local folder.The other proposed option skip the explicit download of the repo with git