https://github.com/svendolin/ultimate-readme-template
Are you struggeling sometimes with your Readme? This Template shows you step by step which elements you can add for a clean and informative README file...
https://github.com/svendolin/ultimate-readme-template
readme readme-edits readme-md readme-profile readme-template readmedesign
Last synced: 2 months ago
JSON representation
Are you struggeling sometimes with your Readme? This Template shows you step by step which elements you can add for a clean and informative README file...
- Host: GitHub
- URL: https://github.com/svendolin/ultimate-readme-template
- Owner: Svendolin
- Created: 2021-09-20T21:57:09.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-11-12T18:16:27.000Z (over 3 years ago)
- Last Synced: 2025-01-20T00:43:39.269Z (4 months ago)
- Topics: readme, readme-edits, readme-md, readme-profile, readme-template, readmedesign
- Homepage:
- Size: 7.81 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
    
***
# Add your Title here ✅
=> Choose a self-explaining name for your project and add a little description
=> Use "Windows" + "." to add emojis to your title 👌😊
=> The third symbol from right on top (with a magnifier symbol) in VSC shows you the preview
=> If you want to know more about design Elements of a README: [MARKDOWN CHEAT SHEET](https://www.markdownguide.org/cheat-sheet/)
***
## Style Elements ✅🎨
---
=> Colour up your text with THIS
=> Use different fonts such as THIS
=> More than TWO SPACE CHARACTERS will create a:
word wrap!
=> Use these brakes to generate SPACING: ```
```
***
## Installation ✅
***
=> Use external sites to refer on informations you got from other web pages such as this [example here.](https://example.com/)
```bash
example guides (if you integrate it into a bash, others can copy this statement)
```
=> Listing some specific steps to guarantee a perfect guidance.
```
$ git clone https://example.com
$ cd ../path/to/the/file
$ npm install
$ npm start
```
=> If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a ```Requirements``` subsection.
***
## Code and Syntax highlighting ✅
***
=> Blocks of code are fenced by lines with three back-ticks. Either you fence a word to highlight it, you fence a whole block of words or you go all in: Fence the desired part and add the suitable language to highlight it the best way as possible:
```javascript
var s = "JavaScript syntax highlighting";
alert(s);
```
```python
s = "Python syntax highlighting"
print s
```
```python
import dogbar
dogbar.pluralize('shiba') # returns 'shibas'
dogbar.singularize('akitas') # returns 'akita'
```
```
No language indicated, so no syntax highlighting.
But let's throw in a tag.
```
=> You can also use raw HTML in your Markdown, and it'll mostly work pretty well.
- Definition list
- Is something people use sometimes.
- Markdown in HTML
- Does *not* work **very** well. Use HTML tags.
***
## Contributing
***
=> Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Therefore we can talk about an "issue template", but hopefully that's not necessary. * Smiles *
***
## License
***
[MIT](https://choosealicense.com/licenses/mit/) 🟢✔
***
## Table of Contents
***
=> A typical "Inhaltsverzeichnis"
1. [General Info and Visuals](#general-info)
2. [Technologies](#technologies)
3. [Installation](#installation)
4. [Collaboration](#collaboration)
5. [FAQs](#faqs)
***
## General Info and Visuals ✅
***
=> Write down the general informations of your project. Furthermore you are always welcome to add screenshots, videos or other visual elements for a better understanding:
***
## Technologies ✅
***
=> Add a list of technologies used within the project:
* [Technologie name](https://example.com): Version 1.0
* [Technologie name](https://example.com): Version 1.1
* [Library name](https://example.com): Version whatever
***
## Collaboration ✅
***
=> Give instructions on how to collaborate with your project.
> A perfect opportunity is to use quotes like these.
> Or another one if you wish.
***
## FAQs ✅
***
=> A list of frequently asked questions
1. **This is a question in bold:**
Answer of the first question with: _italic words_.
2. __Second question in bold:__
To answer this question we use an unordered list:
* First point
* Second Point
* Third point
3. **Third question in bold:**
Answer of the third question with: *italic words*.
4. **Fourth question in bold**
| Headline 1 in the tablehead | Headline 2 in the tablehead | Headline 3 in the tablehead |
|:--------------|:-------------:|--------------:|
| text-align left | text-align center | text-align right |