Skip to content
This repository has been archived by the owner on Feb 10, 2021. It is now read-only.

Refresh README #71

Merged
merged 5 commits into from
Apr 4, 2018
Merged

Refresh README #71

merged 5 commits into from
Apr 4, 2018

Conversation

jakirkham
Copy link
Member

Clarifies a few things in the README after engaging with a user recently.

  • Add badges for PyPI and conda-forge
  • Include install instructions for pip and conda
  • Refresh development install instructions
  • Explain DRMAA_LIBRARY_PATH environment variable must be set

It is preferable to install from `pip` in basically all cases including
when working with local source. So update the recommendation in the
docs.

[ci skip]
Point out to users that they must set the environment variable
`DRMAA_LIBRARY_PATH` to point to their copy of `libdrmaa.so`.

[ci skip]
Provide some basic badges from Shields.io to indicate that dask-drmaa is
available on PyPI and conda-forge with links to the respective sites.

[ci skip]
Explain to users that the package can be gotten from PyPI with `pip` or
conda-forge with `conda` along with example install instructions.

[ci skip]
@lesteve
Copy link
Member

lesteve commented Apr 3, 2018

LGTM

Correct verb conjugation.

[ci skip]
@jakirkham jakirkham merged commit 30f6d25 into dask:master Apr 4, 2018
@jakirkham jakirkham deleted the refresh_readme branch April 4, 2018 02:10
@jakirkham
Copy link
Member Author

Thanks all.

# for free to subscribe to this conversation on GitHub. Already have an account? #.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants