https://github.com/redeagleap/readme-template
This is a small template README.md file for your projects!
https://github.com/redeagleap/readme-template
documentation markdown readme
Last synced: 5 days ago
JSON representation
This is a small template README.md file for your projects!
- Host: GitHub
- URL: https://github.com/redeagleap/readme-template
- Owner: RedEagleAP
- License: mit
- Created: 2018-12-08T15:01:31.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-04-23T06:34:43.000Z (about 7 years ago)
- Last Synced: 2025-02-20T20:16:51.588Z (over 1 year ago)
- Topics: documentation, markdown, readme
- Size: 16.6 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Readme Template
This is a small template README.md file for your projects!
## Table of Contents
- [Intro](#intro)
- [Getting started](#getting-started)
- [Features](#features)
- [Usefull links](#usefull-links)
- [License](#license)
- [Author](#author)
## Intro
Writing the Readme is an integral part of writing a good program. Until you can put your thought in writing, you still can’t start writing code.
There must be a middle ground between the piles of technical specification papers and its absence, as such. And in fact it is. This golden mean is an inconspicuous and modest Readme file.
Consider the process of writing the Readme file for your project as a true act of creation. This is exactly the place where all your brilliant ideas should be expressed.
## Getting started
### Npm&Yarn install:
```bash
#Nostalgic
$ npm install @redeagle/readme-template
#Hipster
$ yarn add @redeagle/readme-template
```
### Clone the repo:
Clone the repo to get all source files as they are available on Github:
```bash
$ git clone https://github.com/redeagleap/readme-template.git
$ cd readme-template/
```
[⇧ back to top](#contents)
## Features
For the header of our `README.md`, we will use HTML markup to centralize the information. Like this:
These tags are used to better navigate the file:
[⇧ back to top](#contents)
## Usefull links
For the badges:
- [Badge.fury.io](https://badge.fury.io/)
- [Shields.io](https://shields.io/#/)
For markdown:
- [StackEdit](https://stackedit.io/app#)
- [MarkdownGuide](https://www.markdownguide.org/)
For Github:
- [gitmoji](https://gitmoji.carloscuesta.me/)
- [Github Octodex](https://octodex.github.com/)
For create awesome code pictures for your docs:
- [Carbon](https://carbon.now.sh/)
Like this:
[⇧ back to top](#contents)
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
[⇧ back to top](#contents)
## Author
```txt
Readme Template made with love.
---------------------------------------
Author : Alexander Prisyazhnyuk
Email : insightinyourmind@gmail.com
Github : https://github.com/redeagleap/readme-template.git
```
[](https://forthebadge.com)
[⇧ back to top](#contents)