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

README.md doesn't tell how to install and use #103

Open
GRiMe2D opened this issue Dec 14, 2020 · 0 comments
Open

README.md doesn't tell how to install and use #103

GRiMe2D opened this issue Dec 14, 2020 · 0 comments
Assignees
@GRiMe2D
Labels
type:documentation Improvements or additions to documentation

Comments

@GRiMe2D
Copy link
Collaborator

GRiMe2D commented Dec 14, 2020

What

Installation and usage should be shown in README.md

Why

README.md is rendered as a home page of the repository. It should show how to install and use it
@GRiMe2D GRiMe2D added the type:documentation Improvements or additions to documentation label Dec 14, 2020
@GRiMe2D GRiMe2D self-assigned this Dec 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@GRiMe2D GRiMe2D

Labels
type:documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@GRiMe2D