Note: This readme template is based on one from the Good Docs Project. You can find it and a guide to filling it out here. (Erase this note after filling out the readme.)
The project name should match its code's capability so that new users can easily understand what it does.
Change to the owner(s) of the new repo. (This template's owners are:)
Requests for work (RFWs) and requests for comments (RFCs) associated with this project:
Project description • Who this project is for • Project dependencies • Instructions for use • Contributing guidelines • Additional documentation • How to get help • Terms of use
Use one of these:
With Project Name you can verb noun...
Project Name helps you verb noun...
This project is intended for target user who wants to user objective.
Before using Project Name, ensure you have:
- Prerequisite 1
- Prerequisite 2
- Prerequisite 3...
Get started with Project Name by (write the first step a user needs to start using the project. Use a verb to start.).
-
Write the step here.
Explanatory text here
(Optional: Include a code sample or screenshot that helps your users complete this step.)
-
Write the step here.
a. Substep 1
b. Substep 2
- Write the step here.
- Write the step here.
- Write the step here.
- Write the step here.
- Write the step here.
- Write the step here.
| Issue | Solution |
| _Describe the issue here_ | _Write solution here_ |
| _Describe the issue here_ | _Write solution here_ |
| _Describe the issue here_ | _Write solution here_ |
Other troubleshooting supports:
- Link to FAQs
- Link to runbooks
- Link to other relevant support information
If you'd like to help out, check out our contributing guidelines.
Include links and brief descriptions to additional documentation.
For more information:
- File an issue.
- Email us at openpecha[at]gmail.com.
- Join our discord.
Project Name is licensed under the MIT License.