Git Readme: Unterschied zwischen den Versionen

Aus Xinux Wiki
Zur Navigation springen Zur Suche springen
(Die Seite wurde neu angelegt: „<pre> ***INSERT GRAPHIC HERE (include hyperlink in image)*** # Repository Title Goes Here > Subtitle or Short Description Goes Here > ideally one sentence…“)
 
Zeile 1: Zeile 1:
 +
=Readme Vorlage=
 +
 
<pre>
 
<pre>
 +
# Titel Hier
  
***INSERT GRAPHIC HERE (include hyperlink in image)***
+
> Untertitel oder kurze Beschreibung
 
 
# Repository Title Goes Here
 
 
 
> Subtitle or Short Description Goes Here
 
 
 
> ideally one sentence
 
 
 
> include terms/tags that can be searched
 
 
 
**Badges will go here**
 
 
 
- build status
 
- issues (waffle.io maybe)
 
- devDependencies
 
- npm package
 
- coverage
 
- slack
 
- downloads
 
- gitter chat
 
- license
 
- etc.
 
 
 
[![Build Status](http://img.shields.io/travis/badges/badgerbadgerbadger.svg?style=flat-square)](https://travis-ci.org/badges/badgerbadgerbadger) [![Dependency Status](http://img.shields.io/gemnasium/badges/badgerbadgerbadger.svg?style=flat-square)](https://gemnasium.com/badges/badgerbadgerbadger) [![Coverage Status](http://img.shields.io/coveralls/badges/badgerbadgerbadger.svg?style=flat-square)](https://coveralls.io/r/badges/badgerbadgerbadger) [![Code Climate](http://img.shields.io/codeclimate/github/badges/badgerbadgerbadger.svg?style=flat-square)](https://codeclimate.com/github/badges/badgerbadgerbadger) [![Github Issues](http://githubbadges.herokuapp.com/badges/badgerbadgerbadger/issues.svg?style=flat-square)](https://github.com/badges/badgerbadgerbadger/issues) [![Pending Pull-Requests](http://githubbadges.herokuapp.com/badges/badgerbadgerbadger/pulls.svg?style=flat-square)](https://github.com/badges/badgerbadgerbadger/pulls) [![Gem Version](http://img.shields.io/gem/v/badgerbadgerbadger.svg?style=flat-square)](https://rubygems.org/gems/badgerbadgerbadger) [![License](http://img.shields.io/:license-mit-blue.svg?style=flat-square)](http://badges.mit-license.org) [![Badges](http://img.shields.io/:badges-9/9-ff6799.svg?style=flat-square)](https://github.com/badges/badgerbadgerbadger)
 
 
 
- For more on these wonderful ~~badgers~~ badges, refer to <a href="http://badges.github.io/badgerbadgerbadger/" target="_blank">`badgerbadgerbadger`</a>.
 
 
 
***INSERT ANOTHER GRAPHIC HERE***
 
  
[![INSERT YOUR GRAPHIC HERE](http://i.imgur.com/dt8AUb6.png)]()
+
> Bestenfalls einen Satz
  
- Most people will glance at your `README`, *maybe* star it, and leave
 
- Ergo, people should understand instantly what your project is about based on your repo
 
  
> Tips
+
## Inhaltsverzeichnis (Optional)
  
- HAVE WHITE SPACE
+
> Bei viel Info auf Zwischenüberschriften zurückgreifen
- MAKE IT PRETTY
 
- GIFS ARE REALLY COOL
 
 
 
> GIF Tools
 
 
 
- Use <a href="http://recordit.co/" target="_blank">**Recordit**</a> to create quicks screencasts of your desktop and export them as `GIF`s.
 
- For terminal sessions, there's <a href="https://github.com/chjj/ttystudio" target="_blank">**ttystudio**</a> which also supports exporting `GIF`s.
 
 
 
**Recordit**
 
 
 
![Recordit GIF](http://g.recordit.co/iLN6A0vSD8.gif)
 
 
 
**ttystudio**
 
 
 
![ttystudio GIF](https://raw.githubusercontent.com/chjj/ttystudio/master/img/example.gif)
 
 
 
---
 
 
 
## Table of Contents (Optional)
 
 
 
> If your `README` has a lot of info, section headers might be nice.
 
  
 
- [Installation](#installation)
 
- [Installation](#installation)
- [Features](#features)
+
- [Eigenschaften](#merkmale)
- [Contributing](#contributing)
 
 
- [Team](#team)
 
- [Team](#team)
 
- [FAQ](#faq)
 
- [FAQ](#faq)
- [Support](#support)
+
- [Lizenz](#lizenz)
- [License](#license)
 
  
  
 
---
 
---
  
## Example (Optional)
+
## Beispiele (Optional)
  
 
```javascript
 
```javascript
Zeile 88: Zeile 39:
 
## Installation
 
## Installation
  
- All the `code` required to get started
+
- Den ganzen code der benötigt wird um zu starten
- Images of what it should look like
+
- Bilder wie es aussehen sollte
  
### Clone
+
### Klon
  
- Clone this repo to your local machine using `https://github.com/fvcproductions/SOMEREPO`
+
- Klone das Repository auf deinen Rechner `https://github.com/fvcproductions/SOMEREPO`
  
 
### Setup
 
### Setup
  
- If you want more syntax highlighting, format your code like this:
+
- Für mehr Hervorhebung, formatieren den code wie folgt:
  
> update and install this package first
+
> Update und Installieren des ersten Pakets
  
 
```shell
 
```shell
Zeile 106: Zeile 57:
 
```
 
```
  
> now install npm and bower packages
+
> Installieren von npm und bower Paketen
  
 
```shell
 
```shell
Zeile 112: Zeile 63:
 
$ bower install
 
$ bower install
 
```
 
```
 
- For all the possible languages that support syntax highlithing on GitHub (which is basically all of them), refer <a href="https://github.com/github/linguist/blob/master/lib/linguist/languages.yml" target="_blank">here</a>.
 
  
 
---
 
---
  
## Features
+
## Eigenschaften
## Usage (Optional)
+
## Benutzung (Optional)
## Documentation (Optional)
+
## Dokumentation (Optional)
 
## Tests (Optional)
 
## Tests (Optional)
  
- Going into more detail on code and technologies used
+
- Gehe mehr ins Detail über den code und über die Maschinen die du nutzt
- I utilized this nifty <a href="https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet" target="_blank">Markdown Cheatsheet</a> for this sample `README`.
 
  
 
---
 
---
 
## Contributing
 
 
> To get started...
 
 
### Step 1
 
 
- **Option 1**
 
    - 🍴 Fork this repo!
 
 
- **Option 2**
 
    - 👯 Clone this repo to your local machine using `https://github.com/joanaz/HireDot2.git`
 
 
### Step 2
 
 
- **HACK AWAY!** 🔨🔨🔨
 
 
### Step 3
 
 
- 🔃 Create a new pull request using <a href="https://github.com/joanaz/HireDot2/compare/" target="_blank">`https://github.com/joanaz/HireDot2/compare/`</a>.
 
  
 
---
 
---
  
## Team
 
 
> Or Contributors/People
 
 
| <a href="http://fvcproductions.com" target="_blank">**FVCproductions**</a> | <a href="http://fvcproductions.com" target="_blank">**FVCproductions**</a> | <a href="http://fvcproductions.com" target="_blank">**FVCproductions**</a> |
 
| :---: |:---:| :---:|
 
| [![FVCproductions](https://avatars1.githubusercontent.com/u/4284691?v=3&s=200)](http://fvcproductions.com)    | [![FVCproductions](https://avatars1.githubusercontent.com/u/4284691?v=3&s=200)](http://fvcproductions.com) | [![FVCproductions](https://avatars1.githubusercontent.com/u/4284691?v=3&s=200)](http://fvcproductions.com)  |
 
| <a href="http://github.com/fvcproductions" target="_blank">`github.com/fvcproductions`</a> | <a href="http://github.com/fvcproductions" target="_blank">`github.com/fvcproductions`</a> | <a href="http://github.com/fvcproductions" target="_blank">`github.com/fvcproductions`</a> |
 
 
- You can just grab their GitHub profile image URL
 
- You should probably resize their picture using `?s=200` at the end of the image URL.
 
 
---
 
  
 
## FAQ
 
## FAQ
  
- **How do I do *specifically* so and so?**
+
- Auftretende Fragen beantworten
    - No problem! Just do this.
 
 
 
---
 
 
 
## Support
 
 
 
Reach out to me at one of the following places!
 
 
 
- Website at <a href="http://fvcproductions.com" target="_blank">`fvcproductions.com`</a>
 
- Twitter at <a href="http://twitter.com/fvcproductions" target="_blank">`@fvcproductions`</a>
 
- Insert more social links here.
 
 
 
---
 
 
 
## Donations (Optional)
 
 
 
- You could include a <a href="https://cdn.rawgit.com/gratipay/gratipay-badge/2.3.0/dist/gratipay.png" target="_blank">Gratipay</a> link as well.
 
 
 
[![Support via Gratipay](https://cdn.rawgit.com/gratipay/gratipay-badge/2.3.0/dist/gratipay.png)](https://gratipay.com/fvcproductions/)
 
  
 +
- **Wie mache ich das *spezielle* so oder so?**
 +
    - Kein Problem! Mach einfach das hier.
  
 
---
 
---
Zeile 191: Zeile 89:
 
## License
 
## License
  
[![License](http://img.shields.io/:license-mit-blue.svg?style=flat-square)](http://badges.mit-license.org)
 
 
- **[MIT license](http://opensource.org/licenses/mit-license.php)**
 
- Copyright 2015 © <a href="http://fvcproductions.com" target="_blank">FVCproductions</a>.
 
  
 +
- Copyright 2015 ©
 
</pre>
 
</pre>

Version vom 15. Juni 2020, 09:20 Uhr

Readme Vorlage

# Titel Hier

> Untertitel oder kurze Beschreibung

> Bestenfalls einen Satz


## Inhaltsverzeichnis (Optional)

> Bei viel Info auf Zwischenüberschriften zurückgreifen

- [Installation](#installation)
- [Eigenschaften](#merkmale)
- [Team](#team)
- [FAQ](#faq)
- [Lizenz](#lizenz)


---

## Beispiele (Optional)

```javascript
// code away!

let generateProject = project => {
  let code = [];
  for (let js = 0; js < project.length; js++) {
    code.push(js);
  }
};
```

---

## Installation

- Den ganzen code der benötigt wird um zu starten
- Bilder wie es aussehen sollte

### Klon

- Klone das Repository auf deinen Rechner `https://github.com/fvcproductions/SOMEREPO`

### Setup

- Für mehr Hervorhebung, formatieren den code wie folgt:

> Update und Installieren des ersten Pakets

```shell
$ brew update
$ brew install fvcproductions
```

> Installieren von npm und bower Paketen

```shell
$ npm install
$ bower install
```

---

## Eigenschaften
## Benutzung (Optional)
## Dokumentation (Optional)
## Tests (Optional)

- Gehe mehr ins Detail über den code und über die Maschinen die du nutzt

---

---


## FAQ

- Auftretende Fragen beantworten

- **Wie mache ich das *spezielle* so oder so?**
    - Kein Problem! Mach einfach das hier.

---

## License


- Copyright 2015 ©