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

Quickstart docs does not include installation instructions #44

Open
YrrepNoj opened this issue Apr 7, 2024 · 1 comment
Open

Quickstart docs does not include installation instructions #44

YrrepNoj opened this issue Apr 7, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@YrrepNoj
Copy link
Member

YrrepNoj commented Apr 7, 2024

Describe what should be investigated or refactored

The Quickstart documentation in the README does not describe how to install the maru-runner release and jumps right into using it. A simple pre-req section that quickly describes how to install maru-runner would be helpful for new people to the project.

@YrrepNoj YrrepNoj added the documentation Improvements or additions to documentation label Apr 7, 2024
@UncleGedd
Copy link
Collaborator

Thanks @YrrepNoj we'll prioritize this

@Racer159 Racer159 added the good first issue Good for newcomers label May 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants