Skip to content

Latest commit

 

History

History
147 lines (101 loc) · 4.23 KB

README.md

File metadata and controls

147 lines (101 loc) · 4.23 KB
Raw
// made with <3

badge-workflow badge-license badge-language badge-pr badge-issues



A simple repository template to get started with GitHub. Say goodbye to repetitive setup tasks and configuration headaches! Simplify your workflow, save time, and ensure consistency across projects.

Let's make starting new projects feel like a breeze again.



 
 Features 
   
 Quick Start 
   
 Contribute 
 


Features

  • Beautiful README
  • Matrix testing CI
  • Draft Releasing CI
  • Pull Request Labeler CI
  • Code of Conduct
  • Code Style Documentation
  • Security Policy Documentation
  • 7 Issue Templates
  • Pull Request Template
  • And more...

Quick Start

1. Creating a repository

Click the green "Use this template" button in the top right corner of the page or the button below to create your new repository.

Use Template

2. Run the setup script

Note

Only Node.Js versions 16, 18, 20 and latest are officially supported.

Run the following command and answer the prompts to complete the setup.

node ./dist/setup.js

3. Final touches

You are almost ready to start building your project. Just a few more steps and you're ready to go!

  • Update CITATION.cff file with your project information.
  • Create and add project images to the images/ directory and update README.md file.
  • Update LICENSE.txt file with your preferred license.
  • Update .github/CODESTYLE.md with your project's preferred code style.
  • Update CONTRIBUTING.md with your project's preferred contribution guidelines.
  • Update the workflow files in the .github/workflows/ directory.

Note

We know that there is still a fair amount of manual setup required, and we are committed to making this process as smooth and painless as possible.

If you have any feedback, please feel free to create an issue or a pull request.

Want to support this project? ✨ Star it on GitHub and help us spread the word!

Special Thanks

  • Img Shields - For the awesome README badges
  • Hyprland - For showing how to make beautiful READMEs
  • Hyprdots - For showing how to make beautiful READMEs

stars-graph