ReadMeCreator With LLM

LLM을 사용하는 Readme Creator

Readme Creator에 오신 것을 환영합니다! 이 도구는 대화식 readme 파일을 생성하는 프로세스를 단순화합니다.

특징

• README 템플릿을 신속하게 만듭니다.
• 사용자 친화적 인 프롬프트로 템플릿을 사용자 정의하십시오.
• 대화식 및 시각적으로 매력적인 readme 파일을 생성합니다.

시작하기

1. 이 저장소를 복제하십시오.

git clone https://github.com/ashishpatel26/readme-creator-with-LLM.git
cd readme-creator

2. 필요한 종속성 설치 :

pip install -r requirements.txt

3. 환경 변수로 내보내면 OpenAI API 키를 설정하십시오.

 export OPEN_AI_KEY=your_openai_key_here

용법

ReadMe Creator를 시작하려면 다음 명령을 실행하십시오.

python src/readme_creator.py

프롬프트를 따라 readme 템플릿을 사용자 정의하십시오. 이 도구는 루트 디렉토리에서 대화식 readme.md 파일을 생성합니다.

예

사전 디자인 된 README 템플릿 및 해당 출력의 examples/ 디렉토리를 확인하십시오.

기여

우리는 기여를 환영합니다! 풀 요청을 제출하십시오.

특허

이 프로젝트는 MIT 라이센스에 따라 라이센스가 부여됩니다. 자세한 내용은 라이센스 파일을 참조하십시오.