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

Create "README.md" file. #7

Open
szymon-filipiak opened this issue Mar 26, 2020 · 0 comments
Open

Create "README.md" file. #7

szymon-filipiak opened this issue Mar 26, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation must have Crucial feature

Comments

@szymon-filipiak
Copy link
Contributor

Good open-source projects have readable and extensive README.md file.

We should create one for our repository, where we will define:

  • the goals of our project,
  • requirements for application,
  • how to install and run the application.

For reference on how to write good README files see this or this.

Please also utilize markdown language capabilities to make it readable and attractive visually.
@szymon-filipiak szymon-filipiak added documentation Improvements or additions to documentation must have Crucial feature labels Mar 26, 2020
@szymon-filipiak szymon-filipiak mentioned this issue Mar 27, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation must have Crucial feature
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@szymon-filipiak