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

[REVIEW] README cleanup #1202

Merged
merged 4 commits into from Mar 15, 2019
Merged

[REVIEW] README cleanup #1202

merged 4 commits into from Mar 15, 2019

Conversation

randerzander
Copy link
Contributor

closes #838

User feedback about cuDF's README indicated it was too dense, with too much information. Users preferred to see a simple motivating example, followed by install instructions, with links to any lengthy build instructions.

Changes:

  1. Simplify project description, removing filler wording where possible
  2. Add cudf/python example
  3. Add links to API docs and notebooks
  4. Move build instructions to BUILD.md
  5. Fix inconsistency between rapids.ai specified conda/pip install arguments

BUILD.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@mike-wendt
Copy link
Contributor

@randerzander @kkraus14 Instead of creating a new BUILD.md file, can we add this to the end of CONTRIBUTING.md like PyTorch does? https://github.com/pytorch/pytorch/blob/master/CONTRIBUTING.md

@mike-wendt
Copy link
Contributor

@randerzander @kkraus14 Instead of creating a new BUILD.md file, can we add this to the end of CONTRIBUTING.md like PyTorch does? https://github.com/pytorch/pytorch/blob/master/CONTRIBUTING.md

That had been the plan for the 0.5 release but we weren't ready and deferred.

README.md Outdated Show resolved Hide resolved
@randerzander randerzander changed the title [REVIEW] README cleanup [WIP] README cleanup Mar 15, 2019
@randerzander randerzander changed the title [WIP] README cleanup [REVIEW] README cleanup Mar 15, 2019
@randerzander
Copy link
Contributor Author

@mike-wendt thanks for the excellent suggestion. I made those changes.

I'll open new PRs to cuML, cuGraph, and cuStrings to follow the same pattern.

@kkraus14 kkraus14 merged commit 97764c2 into rapidsai:branch-0.7 Mar 15, 2019
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.

[DOC] Inconsistent installation instructions
4 participants