A markdown template of README.md for GitHub repositories, specifically for desktop and smartphone applications. It focuses on simple, consistent design and well-structured content. This template tries to avoid HTML syntax and maintain markdown syntax throughout the template to keep the code cleaner and maintainable. A set of images/screenshot resolutions and other standards are recommended below to maintain a consistent layout while trying to make screenshots readable.
The following are recommendations on how to effectively write and structure text content:
- Avoid using AI-generated descriptions. You can use it for inspiration or structuring but try to create your own words to maintain the personality.
- Use proofreading services to identify errors in grammar, punctuation and spelling just in case.
- Be consistent on how you compose sentences, like using the same starting words, where to use declarative/imperative sentences and sentence complexity.
- Read your sentences several times to judge whether they need to be reconstructed or complete trash.
- Template sections can be changed, removed, added and rearranged to fit to preferred style.
- When changing or adding a section title, keep the section title as short as possible with a maximum of three words.
The following are sentence template recommendation if encountered:
- Project Badge: https://img.shields.io/badge/
Environment-Type-COLOR>| - Project Description: A
<app environment>application that... - Installation: Download and install the latest version of
<required library>. - Installation: Go to the latest
<release page>of<app name>. - Acknowledgments:
<contributor>: For<contribution>. - License: This project is licensed under the
<licence name>License
The following are recommendations on how to consistently handle images/screenshots:
- The width resolution is recommended to be followed to maintain a consistent design and avoid images from stacking vertically.
- The height resolution can vary, but is it recommended to keep every image/screenshot resolution identical in a single row.
- If there is a large gap between images/screenshots in a single row, try to order them from tallest to smallest.
- Thumbnail -
25x25
- Single -
width: 640px - Double -
width: 400px Triple -width: 264pxnot recommended.
- Single -
width: 264px - Double -
width: 264px - Triple -
width: 264px
The following are recommendations on how to properly write markdown syntax:
- Do not include another
#as a section. - Use
##for the section header. - Use
###for section sub-header. - Use
[<reference-description>]: <link>for link reference. - Use
![<alternative description>][<link-reference>]for images. - Use
for spacing between images. - Use
**[<contributor>][<link-reference>]**: For <contribution>for acknowledgments. - Use single spacing between sections.
- Use single spacing between references that belong to different sections or purposes.
- Ideal for promotional image and application main screen.
- Recommended for desktop/smartphone (landscape) screenshots.
- Ideal for main features to keep them in one place.
- Recommended for desktop/smartphone (landscape) screenshots.
- Ideal for main features to keep them in one place.
- Recommended for smartphone (portrait) screenshots.
This project is licensed under the MIT License - see the LICENSE file for details.
- Shields.io: For project badge.