Introduction

Welcome to the readme project documentation. This project aims to streamline the README experience for GitHub users by providing easy-to-follow guidelines regarding styling and content components. The primary goals are visuals (appeal as well as clarity) paired with ease of use for whoever is viewing your project. To simplify the adaptation we provide templates over on GitHub allowing you to easily create new projects with a fitting README that can effortlessly be adjusted to your needs:

Type	Repository
Java project	https://github.com/etdon/readme-java

This documentation consists of a generic section in which more generic guidelines are being provided that can be applied to most projects as well as separated sections for specific project types.