NOTE: It is a general template that can be used for a project README.md, example README.md, or any other README.md type in all Kyma repositories in the Kyma organization. Not all the sections are mandatory. Use only those that suit your use case but keep the proposed section order.
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. 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.
List potential issues and provide tips on how to avoid or solve them. To structure the content, use the following sections:
- Symptom
- Cause
- Remedy