세상을 더 편리하게
article thumbnail
[개발일지] ReadMe의 중요성
개발일지 2021. 2. 15. 14:51

과거의 나 사실 readme 파일은 프로젝트를 보는 누가 읽어도 완벽하게는 아니더라도 대략적으로 이해할 수 있게 도와주는 파일이라고 들었다. 하지만 나는 readme파일 작성을 게을리했다. 왜냐하면 어차피 팀프로젝트를 할 때 모든 인원이 오프라인으로 만나 어느정도의 이해를 쌓았기 때문이다. 그렇기에 굳이 정성들여 작성할 필요가 없다고 생각했다. 왜 중요하다고 생각했나? 사실 이건 내가 블로그를 하는 이유와 일맥상통하다. 배달의 민족에서 우아한테크코스(이하 우테코)지원하면서 느낀 점이다. 너는 미친듯이 뭔가에 열정을 다 해본적 있어? 너가 열심히 했던걸 증명해줄레? 내게 미친듯이 열정을 다 해본 것이 코딩이 답이라고 묻는다면, 코딩이 내가 미친듯이 하고 싶어하는 목표의 과정중에 하나라고 생각한다. 그래서 ..

article thumbnail
[Github] Readme 파일 작성하기
Programming/Github & git 2020. 5. 10. 23:59

깃허브는 공개된 장소입니다. 누구나 인터넷만 연결되어 있으면 구경할 수 있습니다. 하지만 방대한 코드와 컨트리뷰션 그래프(기여도 그래프)만 살펴보는 것으로는 이 저장소가 왜 있고 어떤 용도 인지 알기 힘듭니다. 그렇기에 README 파일을 만들어서 이 저장소를 어떻게 사용했고 어떻게 사용하는지 알려줍니다. 더보기 README 파일 만들기 깃허브에서 새로운 레파지토리를 만들고 왼쪽 밑에 [Add a README]를 누릅니다. README 파일에서는 실제 줄 바꿈을 2번 해야 실제 보이는 창에서 줄이 바뀐다. Preview 를 통해서 수정된 내용을 볼 수 있다. 다 작성한 후 밑에 Commit changes 를 통해서 바꿀 수 있다. Preview changes 를 누르면 README 파일이 수정된 내역을 ..