@knu-k/readme-template-autogen v0.0.2
README Template Autogen ๐
readme-template-autogen์ ๋ด๋ถ์ ์ผ๋ก ์กด์ฌํ๋ ํ
ํ๋ฆฟ ๊ธฐ๋ฐ์ผ๋ก ํ๋ก์ ํธ์์ ๋ณด๋ค ๋น ๋ฅด๊ฒ readme ๋ฅผ ์์ฑํ ์ ์๊ฒ ํด์ค๋ค.
๐ฅ ์ค์น
์ด ํ๋ก์ ํธ๋ npm ํจํค์ง๋ก ๋ฐฐํฌ๋ฉ๋๋ค. ๋ค์ ๋ช ๋ น์ด๋ฅผ ํตํด ์ค์นํ ์ ์์ต๋๋ค:
npm install -g @knu-k/readme-template-autogen๐ ์ฌ์ฉ๋ฒ
changelog-gen ๋ช ๋ น์ด
์ค์น ํ, readme-template ๋ช
๋ น์ด๋ฅผ ํตํด README.md ํ์ผ์ ์๋์ผ๋ก ์์ฑํ ์ ์์ต๋๋ค.
readme-template init๐ค ๊ธฐ์ฌ ๋ฐฉ๋ฒ
์ด ํ๋ก์ ํธ์ ๊ธฐ์ฌํ๊ณ ์ถ๋ค๋ฉด, ๋ค์ ๋จ๊ณ๋ฅผ ๋ฐ๋ผ ์ฃผ์ธ์:
- ์ด ๋ฆฌํฌ์งํ ๋ฆฌ๋ฅผ ํฌํฌํฉ๋๋ค.
- ์๋ก์ด ๋ธ๋์น๋ฅผ ์์ฑํฉ๋๋ค (
git checkout -b feature-branch). - ๋ณ๊ฒฝ ์ฌํญ์ ์ปค๋ฐํฉ๋๋ค (
git commit -am 'Add new feature'). - ๋ณ๊ฒฝ ์ฌํญ์ ํธ์ํฉ๋๋ค (
git push origin feature-branch). - Pull Request๋ฅผ ์์ฑํ์ฌ ๊ธฐ์ฌ๋ฅผ ์ ์ถํฉ๋๋ค.
๋ชจ๋ ๊ธฐ์ฌ๋ ๊ธฐ์ฌ ๊ฐ์ด๋๋ผ์ธ์ ๋ฐ๋ผ ์ด๋ฃจ์ด์ ธ์ผ ํฉ๋๋ค.
๐ ๋ผ์ด์ ์ค
์ด ํ๋ก์ ํธ๋ MIT ๋ผ์ด์ ์ค ํ์ ๋ฐฐํฌ๋ฉ๋๋ค. ์์ธํ ๋ด์ฉ์ LICENSE ํ์ผ์ ํ์ธํ์ธ์.
๐จโ๐ป ์ ์
- KNU-K
์ด ํ๋ก์ ํธ์ ๋ํ ๋ ์์ธํ ์ ๋ณด๋ changelog-autogen GitHub ๋ฆฌํฌ์งํ ๋ฆฌ์์ ํ์ธํ ์ ์์ต๋๋ค.