Skip to content

템플릿 기반으로 readme 를 자동으로 만들어주는 도구

License

Notifications You must be signed in to change notification settings

KNU-K/readme-template-autogen

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

README Template Autogen 🎉

npm version

readme-template-autogen은 내부적으로 존재하는 템플릿 기반으로 프로젝트에서 보다 빠르게 readme 를 작성할 수 있게 해준다.

📥 설치

이 프로젝트는 npm 패키지로 배포됩니다. 다음 명령어를 통해 설치할 수 있습니다:

npm install -g @knu-k/readme-template-autogen

📝 사용법

changelog-gen 명령어

설치 후, readme-template 명령어를 통해 README.md 파일을 자동으로 생성할 수 있습니다.

readme-template init

🤝 기여 방법

이 프로젝트에 기여하고 싶다면, 다음 단계를 따라 주세요:

  1. 이 리포지토리를 포크합니다.
  2. 새로운 브랜치를 생성합니다 (git checkout -b feature-branch).
  3. 변경 사항을 커밋합니다 (git commit -am 'Add new feature').
  4. 변경 사항을 푸시합니다 (git push origin feature-branch).
  5. Pull Request를 생성하여 기여를 제출합니다.

모든 기여는 기여 가이드라인에 따라 이루어져야 합니다.

📝 라이선스

이 프로젝트는 MIT 라이선스 하에 배포됩니다. 자세한 내용은 LICENSE 파일을 확인하세요.

👨‍💻 저자

  • KNU-K

이 프로젝트에 대한 더 자세한 정보는 changelog-autogen GitHub 리포지토리에서 확인할 수 있습니다.

About

템플릿 기반으로 readme 를 자동으로 만들어주는 도구

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published