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

Add Development section to the README #200

Open
faultyserver opened this issue Nov 8, 2018 · 0 comments
Open

Add Development section to the README #200

faultyserver opened this issue Nov 8, 2018 · 0 comments
Labels
docs.guides An issue relating to any official guides for Myst docs Generic label for documentation issues. Always include this tag in addition to the specific doc tag

Comments

@faultyserver
Copy link
Member

The Installation section covers installation instructions for end users of Myst, but there's no documentation on how to set up the development environment to be able to contribute to Myst directly.

Since there are no dependencies other than Crystal itself, the setup is pretty minimal, but it should cover cloning the repo, getting the right version of Crystal, and running the tests at the very least.

Additional information would include a run through of the project structure but that may be getting too long for the README.
@faultyserver faultyserver added docs Generic label for documentation issues. Always include this tag in addition to the specific doc tag docs.guides An issue relating to any official guides for Myst labels Nov 8, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs.guides An issue relating to any official guides for Myst docs Generic label for documentation issues. Always include this tag in addition to the specific doc tag
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@faultyserver