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

Update README.md and CONTRIBUTING.md #392

Merged
merged 5 commits into from
Apr 10, 2019
Merged

Conversation

iamrecursion
Copy link
Contributor

@iamrecursion iamrecursion commented Apr 10, 2019

Pull Request Description

The instructions for building and running Luna in the readme had become slightly out of date, and were duplicated between README.md and CONTRIBUTING.md. This PR updates these instructions, as well as removes all the building information from the readme into the contributing document. The latter is linked prominently from the former.

The hope is to further improve the readme to better showcase what Luna is and what it does, to help it better explain the project and its goals.

Checklist

Please include the following checklist in your PR:

  • The documentation has been updated if necessary.
  • The code conforms to the Luna Style Guide.
  • The code has been tested where possible.

@iamrecursion iamrecursion added T - Enhancement p-high Should be completed in the next sprint w-docs Website: Documentation labels Apr 10, 2019
@iamrecursion iamrecursion merged commit 58fd6d0 into master Apr 10, 2019
@iamrecursion iamrecursion deleted the wip/update-readme branch April 10, 2019 13:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
p-high Should be completed in the next sprint w-docs Website: Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants