A README.md template. 💬
Work in Progress.
The aim of this project is to prepare a complete README.md template that can be modified to be used in a variety of projects. It will be expanded and revised as needed.
Disclaimer: This is a simple, ready-to-use template. READMEs can be as elaborate as you need.
- Basic README.md structure.
- Adapt and modify README.md.
- Commit and push your new README.md.
Markdown:
| HEADER 1 | HEADER 2 | |
|---|---|---|
| ITEM | CONTENT | CONTENT |
Markdown:
||HEADER 1|HEADER 2|
|---------|--------|--------|
|ITEM|CONTENT|CONTENT|
- Clone or download the repository.
- Copy and modify README.md.
Contributions are what make the open source community an amazing place to be, learn and grow. Any contributions to README.md are greatly appreciated.
-
Fork the project.
-
Create a Branch:
git checkout -b <name> -
Commit your changes and push to the branch:
git commit -m "commit-name" git push -
Open a Pull Request.
MIT License