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

Improve README and Installation Guide #7580

Merged
merged 5 commits into from
May 29, 2023
Merged

Conversation

kmaehashi
Copy link
Member

Recently we are getting more reports of installation failures, and it looks most issues are happening with CuPy wheels installed on conda env. This PR adds the instruction for Conda users to README to promote using packages from conda-forge.

This PR also removed Coveralls badge which is out-dated, and added several wording improvements.

README.md Outdated Show resolved Hide resolved
@leofang
Copy link
Member

leofang commented May 22, 2023

Would be nice to also copy/paste this sentence:

If you encounter any problem with CuPy installed from ``conda-forge``, please feel free to report to `cupy-feedstock
<https://github.com/conda-forge/cupy-feedstock/issues>`_, and we will help investigate if it is just a packaging
issue in ``conda-forge``'s recipe or a real issue in CuPy.

Ideally, conda package users should file bug reports or support requests to the feedstock, not here (as it'd be too noisy).

@kmaehashi kmaehashi added cat:document Documentation to-be-backported Pull-requests to be backported to stable branch prio:high labels May 22, 2023
@emcastillo emcastillo self-assigned this May 23, 2023
@kmaehashi
Copy link
Member Author

Would be nice to also copy/paste this sentence:

Done!

@kmaehashi kmaehashi changed the title Improve README to add Conda instructions Improve README and Installation Guide May 23, 2023
@emcastillo emcastillo merged commit 57ad5e5 into cupy:main May 29, 2023
@emcastillo emcastillo added this to the v13.0.0b1 milestone May 29, 2023
chainer-ci pushed a commit to chainer-ci/cupy that referenced this pull request May 29, 2023
Improve README and Installation Guide
@kmaehashi kmaehashi deleted the update-readme branch May 31, 2023 09:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cat:document Documentation prio:high to-be-backported Pull-requests to be backported to stable branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants