Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating the readme for new pip install instructions #1089

Merged
merged 3 commits into from
May 25, 2022
Merged

Conversation

jmwright
Copy link
Member

This updates the readme to let users know there are two installation methods now (conda and pip), and lists the limitations of the pip installation. It also slips in a small tweak that was needed in setup.py. PyPi would not accept the long_description in the markdown format without an explicit setting to enable it.

@fpq473 you have been closely involved in getting the pip installs working, so please have a look if you get time.

@codecov
Copy link

codecov bot commented May 24, 2022

Codecov Report

Merging #1089 (bd362d5) into master (893c799) will not change coverage.
The diff coverage is n/a.

❗ Current head bd362d5 differs from pull request most recent head cd91d57. Consider uploading reports for the commit cd91d57 to get more accurate results

@@           Coverage Diff           @@
##           master    #1089   +/-   ##
=======================================
  Coverage   96.35%   96.35%           
=======================================
  Files          40       40           
  Lines        9500     9500           
  Branches     1256     1256           
=======================================
  Hits         9154     9154           
  Misses        204      204           
  Partials      142      142           

📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more

@fpq473
Copy link
Contributor

fpq473 commented May 24, 2022

Text looks correct and clear to me.

Minor: PyPi => PyPI; PyPi makes me think of a RaspberryPi ;)

@jmwright
Copy link
Member Author

PyPi => PyPI

Fixed, thanks.

@jmwright jmwright removed the request for review from adam-urbanczyk May 25, 2022 15:32
@jmwright
Copy link
Member Author

@lorenzncode and @fpq473 have reviewed this and it's only a change to the readme, so I'm going to go ahead and merge.

@jmwright jmwright merged commit 8d10631 into master May 25, 2022
@jmwright jmwright deleted the readme branch October 10, 2022 18:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants