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

Simplify README.md #3108

Merged
merged 2 commits into from
Apr 21, 2021
Merged

Simplify README.md #3108

merged 2 commits into from
Apr 21, 2021

Conversation

willeastcott
Copy link
Contributor

@willeastcott willeastcott commented Apr 20, 2021 •
edited

Cull some sections in the README:

  • Contributing - there's a standard CONTRIBUTING.md that anyone can find
  • License - there's a LICENSE file plus a license type in the sidebar
  • Finding models - it's not for the README to go into such specifics
  • Useful links - added a single line list of links nearer the top

I confirm I have signed the Contributor License Agreement.

@willeastcott willeastcott self-assigned this Apr 20, 2021
@willeastcott willeastcott requested a review from a team April 20, 2021 22:50
@Maksims
Copy link
Contributor

Maksims commented Apr 21, 2021

Regarding CONTRIBUTING.md, it is somewhat hidden, and unless it is known where to look at, how can we better inform about that information?

@willeastcott willeastcott changed the title Update README.md Simplify README.md Apr 21, 2021
@willeastcott
Copy link
Contributor Author

Good point @Maksims. I have updated the pull request template, which is probably a better place to notify people about this:

https://github.com/playcanvas/engine/blob/master/.github/PULL_REQUEST_TEMPLATE.md

@willeastcott willeastcott merged commit 45788ce into master Apr 21, 2021
@willeastcott willeastcott deleted the readme-tweaks branch April 21, 2021 12:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@slimbuck slimbuck slimbuck approved these changes

Assignees

@willeastcott willeastcott

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@willeastcott @Maksims @slimbuck