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 file not included #1

Open
kanishkamakhija opened this issue Oct 2, 2017 · 0 comments
Open

README file not included #1

kanishkamakhija opened this issue Oct 2, 2017 · 0 comments
Labels
REQUIRED

Comments

@kanishkamakhija
Copy link
Member

Documenting what you have created is a very crucial part of development. You must provide a README file along with your project stating the following information

  1. How to run the application/project
    You can also include the link to GitHub Page in your readme.
  2. It's dependencies.
  3. Credits to all those who have contributed to this project.

If you wish to learn more about how to write good readme's you can refer to the following blog.
or enroll in Udacity's course on writing readmes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
REQUIRED
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@kanishkamakhija