However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. Tools like ttygif can help, but check out Asciinema for a more sophisticated method. Visualsĭepending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Many services also have instructions for adding a badge. You can use Shields to add some to your README. On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. If there are alternatives to your project, this is a good place to list differentiating factors. A list of Features or a Background subsection can also be added here. Provide context and add a link to any reference visitors might be unfamiliar with.

Let people know what your project can do specifically. NameĬhoose a self-explaining name for your project. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information. Also keep in mind that while a README can be too long and detailed, too long is better than too short. The sections used in the template are suggestions for most open source projects.

Suggestions for a good READMEĮvery project is different, so consider which of these sections apply to yours. When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!).

Use pull-based deployments for improved Kubernetes management.

Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy.

Analyze your code for known vulnerabilities with Static Application Security Testing(SAST).

Use the built-in continuous integration in GitLab.

Automatically merge when pipeline succeeds.

Automatically close issues from merge requests.

Text adventure games