- Change all emphasized texts
- Delete unused sections
- Use
code formatting - Replace
organdprojin badges link with respective slugs
A concise description of the project specifically.
The project is under active development.
- Features
- Installation and Configuration
- Usage
- Contributing
- Contact
- To-Do list
- Roadmap
- Known Bugs
- Credits and Acknowledgments
- Copyright and Licensing
- Changelog and News
- Notes and References
Features. Demos and visuals - images, animations, and videos are highly encouraged.
Installation and configuration guidance.
# Installation stepsUsage examples.
# ...Please read CONTRIBUTING for details on our code of conduct, and the process for submitting merge requests to us.
Development stack and tooling.
Testing stack and how to run tests.
Operations.
Contacts.
Troubleshooting and preferred ways of providing support.
TODO list.
Roadmap.
Known Bugs.
- Name Surname - author
- Appreciation of other contributors is welcome
- License Name
- Copyright © YEAR Subject
- Changelog
- List other important or interesting news here
List dependencies here, or delete the section, if none.
- Web: Page - the preferred way of referencing
- Web Page Title - also OK
- GitHub - xebis/repository-template: Well-manageable and well-maintainable repository template.
List recommended references here, or delete the section.
List suggested references here, or delete the section.
List further reading links here, or delete the section.