https://github.com/edoardottt/readmenator
Final README.md sample for all kind of projects [ readme, boilerplate, badges, template, github, material, design, opensource, badge, ui, beauty ]
https://github.com/edoardottt/readmenator
design designer forked-repo github markdown material-design open-source open-source-tooling opensource opensourceforgood quality readme readme-badges readme-boilerplate readme-bolierplate readme-edits readme-md readme-quality readme-standard readme-template
Last synced: 3 months ago
JSON representation
Final README.md sample for all kind of projects [ readme, boilerplate, badges, template, github, material, design, opensource, badge, ui, beauty ]
- Host: GitHub
- URL: https://github.com/edoardottt/readmenator
- Owner: edoardottt
- License: agpl-3.0
- Created: 2020-05-29T10:15:05.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-11-10T09:35:50.000Z (about 1 year ago)
- Last Synced: 2025-02-01T03:11:06.322Z (12 months ago)
- Topics: design, designer, forked-repo, github, markdown, material-design, open-source, open-source-tooling, opensource, opensourceforgood, quality, readme, readme-badges, readme-boilerplate, readme-bolierplate, readme-edits, readme-md, readme-quality, readme-standard, readme-template
- Homepage: https://edoardottt.com/
- Size: 261 KB
- Stars: 8
- Watchers: 4
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Final README.md sample for all kind of projects
Coded with 💙 by edoardottt.
Requirements 🔍
----------
`
Insert here
`
- first
- second
Installation 📡
----------
`
Insert here
`
- first
- second
Get Started 🎉
----------
`
Insert here
`
- first
- second
```
function code(this repository) {
this.fork();
}
```
Usage ⚙️
-------
1. Fork this repo
2. Enjoy!
```
function codeSample(thisRepo repository) {
thisRepo.fork()
}
```
Common errors: [COMMON_ERRORS.md](https://github.com/edoardottt/READMENATOR/blob/master/COMMON_ERRORS.md)
Changelog 📌
-------
Detailed changes for each release are documented in the [release notes](https://github.com/edoardottt/READMENATOR/releases).
Contributing 🛠
-------
Just open an issue/pull request. See also [CONTRIBUTING.md](https://github.com/edoardottt/READMENATOR/blob/master/CONTRIBUTING.md) and [CODE OF CONDUCT.md](https://github.com/edoardottt/READMENATOR/blob/master/CODE_OF_CONDUCT.md)
**To Do:**
- [x] Fork this repo
- [x] Enjoy!
License 📝
-------
This repository is under [GNU Affero General Public License v3.0](https://github.com/edoardottt/READMENATOR/blob/master/LICENSE).
[edoardottt.com](https://edoardottt.com/) to contact me.
