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

Update README #4

Open
temikfart opened this issue May 13, 2023 · 0 comments
Open

Update README #4

temikfart opened this issue May 13, 2023 · 0 comments
Assignees
@c71n93 @temikfart @cann3v
Labels
documentation Improvements or additions to documentation readme

Comments

@temikfart
Copy link
Member

Now, no any information about our purposes, license, building and running application in the README.md. I suggest to add the following paragraphs:

  • Logo - Logo of the application
  • Badges - build workflow, code coverage, etc.
  • About - general information about What is it?
  • ToC - Table of Contents with links to another paragraphs
  • Installation and requirements - How to install this application? What are requirements for this?
  • Build - How to build the application?
  • Run - How to run the application?
  • Test - How to run tests?
  • Documentation - Where I can find more info about the application?
  • License - license, which we use.

If some part from the list is not implemented or presented, we can stub it with some text like

We are planning to use Google Test framework for unit-testing.
@temikfart temikfart added documentation Improvements or additions to documentation readme labels May 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@c71n93 c71n93

@temikfart temikfart

@cann3v cann3v

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

No branches or pull requests
3 participants
@c71n93 @temikfart @cann3v