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.

Sign up for GitHub

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

Jump to bottom

Update README #942

Merged
merged 2 commits into from
Aug 7, 2020
Merged

Update README #942

merged 2 commits into from
Aug 7, 2020

Conversation

jyn514
Copy link
Member

@jyn514 jyn514 commented Aug 6, 2020

  • Point users to the /about page
  • Recommend cargo run over docker-compose up
  • Document native dependencies
  • Suggest --registry-watcher disabled for the daemon

Closes #888

@jyn514
Update README
abf1e9d 
- Point users to the /about page
- Recommend `cargo run` over `docker-compose up`
- Document native dependencies
- Suggest `--registry-watcher disabled` for the daemon
@jyn514 jyn514 added A-newcomer-roadblock Area: A problem that isn't a bug, but makes it harder for people to contribute C-enhancement Category: This is a new feature P-medium Medium priority S-waiting-on-review Status: This pull request has been implemented and needs to be reviewed labels Aug 6, 2020
@jyn514
Copy link
Member Author

jyn514 commented Aug 6, 2020

Marking as P-medium since the existing instructions to use docker-compose up lead to really frustrating experiences for new contributors (cc @GuillaumeGomez).

Kixiron
Kixiron approved these changes Aug 6, 2020
View reviewed changes
Copy link
Member

@Kixiron Kixiron left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

README.md Outdated Show resolved Hide resolved
@jyn514 @Kixiron
Improve wording
b4faa1e 
Co-authored-by: Chase Wilson <[email protected]>
@jyn514 jyn514 merged commit 8933caf into rust-lang:master Aug 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Kixiron Kixiron Kixiron approved these changes

Assignees
No one assigned
Labels
A-newcomer-roadblock Area: A problem that isn't a bug, but makes it harder for people to contribute C-enhancement Category: This is a new feature P-medium Medium priority S-waiting-on-review Status: This pull request has been implemented and needs to be reviewed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Split up the README into webpages
2 participants
@jyn514 @Kixiron