Skip to content

README could use some more information #87

@Princesseuh

Description

@Princesseuh

Version

N/A

Describe the Bug

The README is currently a bit barebones, I think it scares people away a bit. I think it'd be great to describe at least the following:

  • Quick Start
  • Development

The Quick Start section should be a smaller https://maudit.org/docs/quick-start/ essentially, just going over installing the CLI, init a new project and how to run the dev server. Astro's install section is a good reference here.

For the development section, just a summary of the commands would be enough. Dodeca's is a good reference

Participation

  • I am willing to submit a pull request for this issue.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions