Skip to content

Add Development section to the README #200

@faultyserver

Description

@faultyserver

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsGeneric label for documentation issues. Always include this tag in addition to the specific doc tagdocs.guidesAn issue relating to any official guides for Myst

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions