Git Readme
Version vom 15. Juni 2020, 08:56 Uhr von Robin.will (Diskussion | Beiträge) (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…“)
***INSERT GRAPHIC HERE (include hyperlink in image)***
# 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.
[](https://travis-ci.org/badges/badgerbadgerbadger) [](https://gemnasium.com/badges/badgerbadgerbadger) [](https://coveralls.io/r/badges/badgerbadgerbadger) [](https://codeclimate.com/github/badges/badgerbadgerbadger) [](https://github.com/badges/badgerbadgerbadger/issues) [](https://github.com/badges/badgerbadgerbadger/pulls) [](https://rubygems.org/gems/badgerbadgerbadger) [](http://badges.mit-license.org) [](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***
[]()
- 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
- HAVE WHITE SPACE
- 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**

**ttystudio**

---
## Table of Contents (Optional)
> If your `README` has a lot of info, section headers might be nice.
- [Installation](#installation)
- [Features](#features)
- [Contributing](#contributing)
- [Team](#team)
- [FAQ](#faq)
- [Support](#support)
- [License](#license)
---
## Example (Optional)
```javascript
// code away!
let generateProject = project => {
let code = [];
for (let js = 0; js < project.length; js++) {
code.push(js);
}
};
```
---
## Installation
- All the `code` required to get started
- Images of what it should look like
### Clone
- Clone this repo to your local machine using `https://github.com/fvcproductions/SOMEREPO`
### Setup
- If you want more syntax highlighting, format your code like this:
> update and install this package first
```shell
$ brew update
$ brew install fvcproductions
```
> now install npm and bower packages
```shell
$ npm 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
## Usage (Optional)
## Documentation (Optional)
## Tests (Optional)
- Going into more detail on code and technologies used
- 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> |
| :---: |:---:| :---:|
| [](http://fvcproductions.com) | [](http://fvcproductions.com) | [](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
- **How do I do *specifically* so and so?**
- 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.
[](https://gratipay.com/fvcproductions/)
---
## License
[](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>.