깃허브2 [깃허브] README 파일 잘쓰기 README 란? 깃허브의 README 파일은 프로젝트에 대한 설명과 사용 방법을 기술하는 중요한 문서이다. 👉 README 파일을 통해 다른 사용자들에게 프로젝트를 소개하고 협력하거나 기여할 수 있는 방법을 제시할 수 있다. 👉 포인트는 최대한 간결하고 명확하게 작성 README 파일을 잘 쓰는 팁! 1. 목적과 개요 👉 프로젝트의 목적과 개요를 간략히 설명하며, 프로젝트의 주요 기능이나 이점을 간결하게 제시 2. 설치 방법 👉 필요한 의존성 패키지나 라이브러리를 어떻게 설치해야 하는지 명시 3. 사용 방법 👉 사용자가 프로젝트를 어떻게 실행하고 사용해야 하는지 설명 ; 명령어 예시나 실행 단계를 제공하는 방법 등이 있음 4. 기여 방법 👉 만약 오픈 소스 프로젝트라면, 기여하는 방법을 명시하는 것이 .. 2023. 7. 31. 1.Github Repository 생성과 로컬 연결 Github Repository 생성과 로컬저장소 연결하기 1. 깃허브에서 원격 Repository 생성하기 화면 상단 + 버튼을 눌러 'new repository' 클릭 2. 새로만들 Repository 세팅하기 저장소 이름을 입력 : 보통 로컬 폴더와 동일한 이름을 사용한다 일반적으로 Public으로 개설 : 배운 내용 아카이빙 목적이라면 publid을 추천합니다 Add a README file : 선택 시 , README file이 생성되며 새로 만든 repository를 소개하는 문구를 작성할 수 있습니다(마크다운) Add .gitignore : 하위 메뉴를 통해 사용하는 언어를 선택하면 .gitignore 파일 자동 생성 예) 파이썬 프로젝트를 아카이빙하는 목적이라면, 'python' 선택! 아.. 2023. 7. 25. 이전 1 다음 728x90
