🕶 Awesome list template with CI and required conventions out of the box! © Fork of https://github.com/jthegedus/awesome-list-template

awesome awesome-list template

Go to file Use this template

Pim Snel 691e59f90f docs: note to replace readme-template.md (#11 )		2022-07-30 16:21:59 +10:00
.github/workflows	chore: update template & instructions (#10 )	2022-06-16 03:07:45 +10:00
ci	chore: update template & instructions (#10 )	2022-06-16 03:07:45 +10:00
.gitattributes	add gitattributes file	2019-04-14 21:07:49 +10:00
.tool-versions	ci: use asdf for nodejs	2021-07-15 12:50:39 +10:00
code_of_conduct.md	chore: update to Contributor Covenant 2.0 (#7 )	2021-07-15 09:49:39 +10:00
contributing.md	chore: update template & instructions (#10 )	2022-06-16 03:07:45 +10:00
license	GitHub Action CI Template (#1 )	2020-02-18 18:25:28 +11:00
readme-template.md	chore: update template & instructions (#10 )	2022-06-16 03:07:45 +10:00
readme.md	docs: note to replace readme-template.md (#11 )	2022-07-30 16:21:59 +10:00

Awesome List Template

This is an awesome-list template with CI to run awesome-lint and awesome_bot to be compliant from the beginning.

Usage

generate a template of this repo
run a find & replace of YOUR_GITHUB_USER/YOUR_REPO with your details
edit readme-template.md
- update the h1 title
- update the subtitle
- update the description
- add img src, make it link to the site of the thing in the image.
choose a CI template
- GitHub Action: move config folder from repo-root/ci/.github/ to repo-root/.github
- Circle CI: move config folder from repo-root/ci/.circleci/* to repo-root/.circleci/*
- GitLab CI: move config file from repo-root/ci/.gitlab-ci.yml to the repo-root/.gitlab-ci.yml
run a find & replace readme-template.md to readme.md in the CI you chose
delete this file
rename readme-template.md file to readme.md

Contributions welcome!