팁기 위해 readme 파일(그리고 그 이유는 것이 중요)
우리는,개발자, 은 매우 좋은 코드와 모든 정보는 우리의 프로젝트입니다. 그러나 우리 중 일부(나 포함)는 온라인 커뮤니티에서도 소프트 스킬이 부족합니다.,개발자는 단일 버튼의 패딩과 여백을 조정하는 데 1 시간을 소비합니다. 그러나 프로젝트 설명 Readme 파일에 15 분을 아끼지 않을 것입니다.
난 당신의 대부분이 이미 알고 무엇을 추가 정보.md 파일과 그것이 무엇을 위해 사용. 그러나 여기 초보자를 위해 나는 그것이 정확히 무엇인지 설명하려고 노력할 것입니다.
는 무엇입 Readme.md?
추가 정보(이름에서 알 수 있듯이:”읽기”나)의 첫번째 파일을 읽어야 하나를 시작할 때 새로운 프로젝트입니다., 그것은 프로젝트와 매뉴얼의 종류에 대한 유용한 정보의 집합입니다. 그것은 github 의 첫 번째 파일 또는 누군가가 당신의 저장소를 열 때 어떤 힘내 호스팅 사이트가 표시됩니다..
으로 명확하게 확인할 수 있습 여기 추가 정보.md 파일에서 루트의 저장고가 자동으로 표시하여 github 에서 아래 프로젝트 디렉토리에 있습니다.
및.md확장은 단어 인 markdown 에서 비롯됩니다., 텍스트 서식 지정을위한 마크 업 언어입니다. 그냥 HTML 처럼 그것은 우리의 문서 흉 수 있도록 마크 업 언어입니다.
다음은 markdown 파일의 예이며 실제로 github 에서 렌더링하는 방법입니다. 마크 다운 파일의 미리보기를 동시에 보여주는 미리보기를 위해 VSCode 를 사용합니다.
여기에 공식 Github 속임수를 위한 장을 마크 다운 형식으로 필요하신 경우에는 깊은 거하는 언어입니다.
이제 비즈니스를 이야기합시다., 당신은 프로젝트에 몇 시간을 보냈고,GitHub 에서 공개했으며 사람들/채용 담당자/동료/(예?)프로젝트를 참조하십시오. 당신은 정말로 그들이 당신의 아름다운 논리를보기 위해root/src/app/main.js에 들어갈 것이라고 생각합니까? 진심으로?
이제 귀하의 관심을 얻었으니,이것을 해결하는 방법을 살펴 보겠습니다.
서 문서를 생성하기 위한 구성 요소
이외에 귀하의 프로젝트의 읽어보기 문서화,구성 요소입니다 중요한에 대해 이해할 수 있었습니다. 구성 요소를 재사용하고 코드를 유지 관리하는 것이 훨씬 쉬워집니다., Bit(Github)와 같은 도구를 사용하여 bit 에서 공유되는 구성 요소에 대한 문서를 자동 생성합니다.dev
프로젝트에 대한 좋은 설명을 작성하십시오. 그냥 지침,할 수 있는 형식의 설명으로 다음과 같은 항목:-
- 제목(Title 이미지는 너무 가능한 경우…에서 편집 칸바.,당신이 그래픽 디자이너가 아닌 경우 com.)
- 설명(을 설명 에 의해 단어 및 이미지 모두)
- 모(이미지,동영상,링크를 링크 라이브 데모)
- 사용되는 기술
- 특별한 주의 사항이 귀하의 프로젝트(문제에 직면,고유의 요소 프로젝트)
- 기술적 설명의 프로젝트에 같은 설치,설정,어떻게 기여합니다.
의 다이빙에 깊은 교
나이 하나를 사용 프로젝트 참조로는 생각은 하나의 가장 아름다운 readme 파일을 썼어요 심지어왔습니다., 을 확인할 수 있습의 코드를 추가 정보.md 파일이 여기:-
연필 아이콘을 사용하여 인하 코드:-
이미지 추가! 제발!
당신은 사진 메모리가있을 수 있지만 독자는 프로젝트의 데모의 실제 사진이 필요할 수 있습니다.
예를 들어 solitaire 프로젝트를 만들고 readme 에 설명으로 이미지를 추가했습니다.,
Now you may want to add a video description of your projects too. Just like I did. BUT… Github doesn’t let you add a video to the readme… So… So what?
…WE USE GIFS
Gif 는 이미지 범주에 속하며 github 를 사용하면 readme 에 가질 수 있습니다.
명예의 배지
귀하의 readme 에 배지는 시청자에게 진정성의 느낌을줍니다., 당신이 얻을 수 있는 사용자 지정/정기적으로 사용되는 방패(기장)에 위치한에서 저장소:-https://shields.io
얻을 수 있는 개인화된 방패와 같은 수의 별에 저장소 및 코드 백분율 지표 too.
라이브 데모 추가
가능한 경우 프로젝트를 호스팅하고 실행중인 데모를 설정하십시오. 그 후이 데모를 README 에 연결하십시오., 당신은 얼마나 많은 사람들이 당신의 프로젝트와 함께 놀러 끝낼 수 있습니다 아무 생각이 없습니다. 그리고 채용 담당자는 라이브 프로젝트를 좋아합니다. 그것은 당신의 프로젝트가 github 에 누워 코드의 단지 덤프가 아니며 실제로 사업을 의미 할 보여줍니다.
사용할 수 있는 하이퍼링크에서 당신의 Readme. 따라서 제목 이미지 바로 아래에 라이브 데모 링크를 제공하십시오.
코드 Formating 사용
Markdown 은 텍스트 서식을 코드로 지정할 수있는 옵션을 제공합니다., 그래서 쓰지 않는 코드는 일반 텍스트로 대신 사용하`(물결)을 포장 코드가 내부에 코드를 포맷 이와 같-var a = 1;
Github 또한 옵션을 제공합을 지정하는 언어 코드를 작성할 수 있도록 사용하여 특정한 텍스트가 가장 강력하고 사용자 코드를 읽을 수 있습니다. 이를 위해 사용.
“{언어 확장자}<공간>{코드 블록 안에}“
{“}-트리플 물결표 사용을 위해 멀티-라인 코드고 그것도 지정할 수 있는 언어의 코드 블록입니다.,
With Language Highlighting:-
Without Langage Highlighting:-
Use of HTML
Yes, you can use HTML inside. Not all the features though. But most of it., 마크 다운에만 충실해야하지만 readme 에서 이미지 및 텍스트를 중앙 집중화하는 것과 같은 일부 기능은 HTML 에 의해서만 가능합니다.
답글 남기기