README.md

[Git] Github 레포지토리, README.md 란

Github 레포지토리(Repository) 원격 레포지토리 or 리모트 레포지토리: github 에서 만든 레포지토리(Repository) 안전성(백업의 기능) 협업 가능 로컬레포지토리 : 내 pc 의 레포지토리 README.md GitHub에서는 README.md 파일을 프로젝트의 메인 화면에 보여주기 때문에 README.md 파일의 내용을 가독성있게 작성하는 것이 중요 프로젝트가 어떤 프로젝트인지 설명 프로그램의 주요 사용법을 설명 프로그램을 실행시키려면 어떤 사전 작업이 필요한지 설명

[Git]README.md 작성법 README 란?

README 파일이나 프로젝트 등에 포함된 정보 보통 소프트웨어가 배포될 때 함께 포함되어 있음 why README 가 필요한 이유 본인을 위하여 자신이 코딩한 프로그램이더라도, 다시 읽어보고 해석해야 이해가 가능 경우가 많다. 미래를 위해서 미리 Readme 를 작성해놓으면 필요할 때 프로그램을 이해하기 수월하다. 협업하는 동료들을 위하여 함께 프로젝트를 할 때, 지침서 역할로 유용하다. 사용자들을 위하여 서비스를 구현하거나, 프로젝트가 오픈소스라면 이용자들을 위한 지침서로 유용하다. How 정해져 있는 양식이 존재하는 것은 아니다. txt, md 등등 다양한 형식을 사용할 수 있다. github에서는 보통 Markdown 형식의 README.MD 를 사용하고 권장한다. 간단명료한 것이 효율적이다. 구..