README_template

Build and make your own beautiful GitHub READMEs in minutes ヾ(⌐■_■)ノ♪

This repository aims to give the tools and the templates to build better READMEs so that all your projects will be completly stylized!!! ✪ ω ✪

Important

The templates in the /templates directory have all been extracted from external GitHub repositories and projects created by third-party authors.

The README files and templates are the result of their work. All rights remain reserved by their respective authors.

Each template is distributed under the license of the original repository from which it was sourced. A link to the original repository is provided at the beginning of each document, where you can find the applicable license and attribution information.

---

✨ Credits & template source repositories

01_readme_rayanemy

Original GitHub repository:
https://github.com/rayanemy/eb_jepa

02_readme_chasecheese

Original GitHub repository:
https://github.com/chasecheese/LMCache

03_readme_torvalds

Original GitHub repository:
https://github.com/torvalds/linux

04_readme_chasecheese

Original GitHub repository:
https://github.com/chasecheese/nano-vllm

05_readme_odersky

Original GitHub repository:
https://github.com/odersky/odersky.github.io

06_readme_errikos

Original GitHub repository:
https://github.com/errikos/indico

07_readme_errikos

Original GitHub repository:
https://github.com/errikos/vscode-ayu

---

o(￣▽￣)o Usage

For the templates present in the /templates directory, you can inspire yourself from the designs or use them in allegation to the corresponding licenses of their repositories.

All the code, the templates, the badges in the /raw_templates and /elements directories are totally freee to use without any restriction. (⌐■_■)

---

🔄 Customization

Make the templates your own by customising it with your repository parameters, informations, add badges, GIFs, pictures, screenshots and paste it into your own README.

---

📂 Repository structure

README_template
│
├── templates/
│   ├── 01_readme_rayanemy.md
│   ├── ...
│
├── raw_templates/
│   ├── XX_01_readme.md
│   ├── ...
│
├── elements/
│   ├── components.md
│   ├── badges.md
│   ├── ...
│
├── README.md
├── LICENSE.md
└── .gitignore

---

༼ つ ◕_◕ ༽つ Contributors

---

📄 License

In the /templates directory, each file has its own license regarding to its original source repository. For more details on the orther files excluding the /templates directory, see the LICENSE file.

---

Made with ❤️ by SalimMc

⭐ If this repository helped you, you know what to do!