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

Add a readme file #2

Open
krab7191 opened this issue Oct 5, 2020 · 4 comments
Open

Add a readme file #2

krab7191 opened this issue Oct 5, 2020 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@krab7191
Copy link
Collaborator

krab7191 commented Oct 5, 2020

Add a readme file that describes the project and how to clone it, install dependencies and run it. It would be nice to have a contributing guide as well if this moves forward as an open-source project.

Acceptance criteria

  • Add a readme.md file
  • Have a section that describes how to get the project set up for development, aka clone install + run
  • A section that describes what the project's MVP is (What the minimum functionality your're shooting for is)
@krab7191 krab7191 added documentation Improvements or additions to documentation good first issue Good for newcomers labels Oct 5, 2020
@allisonc2lee
Copy link

allisonc2lee commented Oct 6, 2020

#3 can you please add a "hacktoberfest-accepted" to the issue

@abhishekpatel946
Copy link

Hey @krab7191,
I want to work on this issue and created an awesome README.md

@SHIVANI0708
Copy link

hey @krab7191,
I want to contribute to this issuse.

@krab7191
Copy link
Collaborator Author

krab7191 commented Oct 6, 2020

@chingchinglcc @abhishekpatel946 @SHIVANI0708 this is not a hacktoberfest repository.

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

5 participants