안녕하세요,
재재입니다.
이번 포스팅에서는,
ChatGPT로 Github README 만들기 컨텐츠를 진행해보겠습니다.
ChatGPT 로 생성한 README.md 결과물 이 궁금하시면 눌러주세요.
ChatGPT 활용하는 방법이 다른 포스팅도 확인하실 수 있습니다.
ChatGPT로 Github README.md 만들기
(1) ChatGPT Plus 설정
먼저,
ChatGPT Plus 의 설정에서 “Advanced data analysis” 을 활성화해야합니다.
이후,
ChatGPT 4 를 클릭해주시고,
Advanced Data Analysis (현재 BETA 버전) 을 눌러주시면 되겠습니다.
(2) ChatGPT 에게 결과물 전달 및 요청
README.md 생성에 앞서,
링크를 먼저 전달했는데요!
아직은 지원되지 않기 때문에,
압축파일 형태로 전달해야겠습니다.
(3) ChatGPT README.md 작성 중 시행착오
작성한 Github의 내용을 파악하는 데 약간 어려우미 있었기 때문에,
가능한 최대한 정보를 제공하면서 작성을 요청해야했습니다.
이런 방식으로 가능한 내용을 제공하면서,
ChatGPT 가 우리가 원하는 대로의 결과를 얻을 수 있도록,
수차례 다시 요청하는 과정이 필요했습니다.
특히, Github 이모지를 마크다운 문법 그대로 사용하지 않않고,
최초 GPT 가 제공해준 이모지는 깨져있었기 때문에 (unicode 등의 에러로 추정),
문법을 사용해서 만들어달라고 요청이 필요했습니다.
(4) ChatGPT Github README.md 최종본
ChatGPT 가 제공해준 README.md 를,
커밋 을 진행했고, 아래는 그에 대한 일부입니다.
(5) 결론
ChatGPT 를 활용해서 README.md 등과 같은,
문서화하거나 가이드 문서를 만드는 등의 작업은 충분히 가능하다고 생각했습니다.
In-Context Learning 을 사용하는 GPT 답게,
수차례 대화가 필요하긴 했지만 그 결과 생각했던 것보다 만족스러운 결과를 만들었습니다.