NOTE: This is a general template that you can use for a project README.md. Except for the mandatory sections, use only those sections that suit your use case but keep the proposed section order.
Mandatory sections:
OverviewPrerequisites, if there are any requirements regarding hard- or softwareInstallationContributing- do not change this!Code of Conduct- do not change this!Licensing- do not change this!
Modify the title and insert the name of your project. Use Heading 1 (H1).
Provide a description of the project's functionality.
If it is an example README.md, describe what the example illustrates.
List the requirements to run the project or example.
Explain the steps to install your project. If there are multiple installation options, mention the recommended one and include others in a separate document. Create an ordered list for each installation task.
If it is an example README.md, describe how to build, run locally, and deploy the example. Format the example as code blocks and specify the language, highlighting where possible. Explain how you can validate that the example ran successfully. For example, define the expected output or commands to run which check a successful deployment.
Add subsections (H3) for better readability.
Explain how to use the project. You can create multiple subsections (H3). Include the instructions or provide links to the related documentation.
Add instructions on how to develop the project or example. It must be clear what to do and, for example, how to trigger the tests so that other contributors know how to make their pull requests acceptable. Include the instructions or provide links to related documentation.
See CONTRIBUTING.md.
See CODE_OF_CONDUCT.md.
See the LICENSE file.