Remember that your README.md is the landing page of your repository. It should have complete documentation to your project or pointers to it, including how to install, prepare an environment for, and how to use your software. Also, badges from CI are good there too.
Remember that your README.md is the landing page of your repository. It should have complete documentation to your project or pointers to it, including how to install, prepare an environment for, and how to use your software. Also, badges from CI are good there too.