User Tools

Site Tools


Sidebar

Imprint

code:common:readme

Table of Contents

21 README

Proper documentation is vital for open-source projects, and in addition is also useful for virtually any commercial project too. A README file constitutes a big part of documentation, as this is the first file an end-user sees and should be clear, concise, comprehensive and maybe also a bit fun.

Guidelines

Our README structure is based on the above requirements, whilst being tailored to both our internal and external projects. Our README provides an overview of the project, installation, usage and configuration instructions, contribution guidelines, credits and of course, the indispensable license overview. The file also usually contains a screenshot, badges and several colourful icons, which makes it aesthetically pleasing.

Markdown

Emoticons

Example

# readme formatting

[![coverage](https://gitlab.com/gitlab-org/gitlab-ee/badges/master/coverage.svg?job=coverage)](https://gitlab-org.gitlab.io/gitlab-ee/coverage-ruby)

project to showcase different readme designs


## :memo: Description 

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut iaculis sit amet magna non feugiat. Nulla in risus scelerisque, tempus leo et, ornare sapien. Maecenas sapien enim, aliquam non ex in, pellentesque dignissim nibh. Morbi sapien dolor, accumsan nec commodo in, euismod vitae neque. Aliquam finibus orci nec enim pulvinar, eget dictum metus ultrices. Proin maximus blandit massa vulputate vehicula. Ut aliquam, nunc non pulvinar tristique, quam nisl vehicula sem, eu consequat metus elit eget diam.


## :camera: Screenshot 

![labview](https://proxy.duckduckgo.com/iu/?u=http%3A%2F%2Fforums.ni.com%2Flegacyfs%2Fonline%2F202594_Hololens_LabVIEW_simple_example.png&f=1)


## :rocket: Installation

```
Orci varius natoque 
    penatibus et magnis 
    dis parturient montes, 
nascetur ridiculus mus. 
```

In hac habitasse platea dictumst. Praesent nec urna quis leo faucibus dapibus vel vitae augue. Nullam porttitor lorem vel odio consectetur vulputate. Maecenas luctus orci id orci hendrerit, eu iaculis arcu pellentesque. Cras a eros ac velit elementum lacinia. Nunc in viverra nunc.

## :bulb: Usage

In in ante eros. Curabitur eleifend id lectus vitae gravida. Morbi sit amet nibh auctor, auctor erat non, facilisis tellus. Cras eget fringilla sapien, quis placerat arcu. Morbi non quam ac tortor fermentum volutpat in vitae enim. Suspendisse suscipit orci nibh, ornare consectetur felis dapibus a. Pellentesque at malesuada orci. Fusce ac congue nisi, ut dictum ipsum. Phasellus molestie lorem felis, ac pulvinar metus commodo non. Quisque eu ex ac magna tempor aliquet ac vitae libero. Donec vulputate efficitur ante quis tempor. Praesent vehicula mattis diam, sit amet pellentesque sapien egestas vitae. Nam pulvinar feugiat enim, eu tristique magna iaculis a. Quisque nec varius nisl, a dictum nulla. Vivamus pellentesque sit amet mauris in fermentum.

## :wrench: Configuration 

Nulla ultricies gravida dui vel pharetra. Sed felis orci, vehicula sit amet bibendum quis, mollis id lacus. Nullam congue dignissim libero at rhoncus. Phasellus molestie consectetur quam, nec maximus nisl aliquam et. Morbi ullamcorper, sem at consequat iaculis, odio massa laoreet orci, in finibus est tortor nec metus. Sed dictum velit eget leo scelerisque, sed maximus odio cursus. Fusce aliquam et eros sollicitudin bibendum. Sed eget nunc suscipit, ornare nulla ac, ornare nunc. Duis lobortis efficitur fermentum. Nam lobortis nibh eget eros porttitor, et scelerisque odio tristique. Proin at massa et nisi lobortis malesuada. Quisque a porta nibh.

## :building_construction: Applications 

Duis malesuada, justo non malesuada placerat, augue metus varius neque, non dictum felis nibh non arcu. Nunc tincidunt nisi quis lacus consectetur, eget luctus dolor hendrerit. Aliquam volutpat bibendum neque, id tincidunt ante tempor ut. Mauris eget maximus ligula. Fusce in diam ut tellus molestie fermentum et id enim. Cras pellentesque rhoncus velit nec blandit. Proin fringilla massa nisi, vitae eleifend leo accumsan in. Vestibulum facilisis mauris maximus mattis dignissim. Fusce laoreet massa vel justo gravida, at interdum urna luctus. Suspendisse finibus sollicitudin felis, sed tristique sem rhoncus id. Suspendisse pretium eros neque, congue dignissim metus scelerisque ut.

## :busts_in_silhouette: Contributing 

Praesent fringilla nibh eget urna aliquam faucibus. Aenean at arcu fermentum, elementum risus at, convallis magna. Etiam eu ante a sapien rutrum dapibus quis in felis. Donec euismod enim quis auctor consectetur. Donec tempus nibh et mi porta fringilla. Nam quis justo quis arcu maximus dapibus et malesuada nisi. Donec nec nisi ornare, suscipit tellus ac, condimentum odio. Curabitur ultrices luctus hendrerit. Aenean vel elit eget lacus suscipit porttitor. Nam sit amet ullamcorper magna. Quisque in nisl nisl. Sed eget commodo felis, ac suscipit neque. Aliquam dignissim ipsum in neque maximus placerat.

##  :beers: Credits

* Hat tip to anyone whose code was used
* Inspiration
* etc

## :page_facing_up: License 

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
code/common/readme.txt · Last modified: 2019/09/29 13:18 by joerg.hampel