Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

0. README.md에 대한 조사 #19

Open
1013115 opened this issue Sep 4, 2022 · 0 comments
Open

0. README.md에 대한 조사 #19

1013115 opened this issue Sep 4, 2022 · 0 comments
Labels
조사 Improvements or additions to documentation

Comments

@1013115
Copy link
Collaborator

1013115 commented Sep 4, 2022

README.md

소스코드에 앞서 어떠한 목적으로 개발이 되었는지, 코드의 개요, 구조도 등을 처음 사람들에게 노출함으로써 해당 프로젝트에 대해 설명함


README(리드미)란?

  • 리드미 파일은 디렉토리나 압축 파일에 포함된 기타 파일에 대한 정보를 가지고 있으며, 일반적으로 소프트웨터와 함께 배포됌.
  • 현재 git과 같은 저장소에서 해당 파일을 default로 생성하여 저장소에 대한 설명을 기입하도록 하고 있음
  • 리드미의 파일 형태는 README.TXT, README.md, README.1ST, README.DOC READ.ME 또는 간단히 README 등 많은 파일 명과 확장자 형태를 가지고 있습니다
  • README가 일반적으로 포함한 정보들

README 작성법

readme작성은 사실 사용자 마음대로 작성해도 되지만 Markdown 문법에 맞게 작성하면 html과 같이 더 멋지게 꾸밀 수 있습니다.

@1013115 1013115 added the 조사 Improvements or additions to documentation label Sep 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
조사 Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant