[포스코 x 코딩온] 스마트팩토리 16주차 회고 | github README 작성

이남웅·2023년 7월 6일
0

이번에 포토폴리오를 작성하면서 정리가 전혀 안되어있던 github 프로젝트를 정리할 필요성을 느껴서 어떻게 정리를 했는지에 대해 소개를 하겠습니다.

데이터로 보는 기후

URL: https://github.com/namwlee99/climate_data_visualization

포토폴리오처럼 간단하고, 최대한 가독성있게 작성하였습니다.

처음에는 간단한 프로젝트 설명을 넣어주고 빅데이터를 활용한 프로젝트이기 때문에 어떤 데이터셋을 사용하는지와 개발기간, 간단한 동작방식 순으로 서술하였습니다. 마지막으로는 어떤 프로젝트인지 한눈에 알 수 있게 시각화 예시 사진 하나를 첨부하였습니다.

물류관리 시스템

URL: https://github.com/namwlee99/logistics_management_system

기본적인 구조는 위의 프로젝트와 같지만, 물류관리 시스템은 팀 프로젝트이기 때문에 중간에 팀구성을 넣어서 자신이 어떤 업무를 맡았는지 서술하였습니다. 그리고 부품에 대한 설명을 넣은 이유는 사용한 부품이 꽤 많아서 알기 쉽게 추가하였습니다. 사용한 부품이 적으면 작품소개나 동작방식에 서술해도 되니 굳이 안넣어도 될 것 같습니다.

그리고 사용한 부품이 꽤 많기 때문에 한눈에 볼 수 있게 블록도와 회로도를 추가하였습니다. 그리고 작품사진과 작동 동영상을 마지막으로 서술하였습니다.

프로젝트의 규모나 주제에 따라 작성방법이 많이 달라지니 다른 프로젝트가 어떻게 작성하였는지 참고하면서 작성하면 좋을 것 같습니다.

0개의 댓글