cryptoadvocate/dcsgonefwbspCircuit Crafters의 첫 번째 전자 배지 프로젝트의 펌웨어 보드 지원 패키지 홈.
GitLab을 시작하는 데 도움이 되도록 권장되는 다음 단계 목록을 제공합니다.
이미 전문가이신가요? 이 README.md를 편집하여 직접 만들어 보세요. 간편하게 만들고 싶으신가요? 하단의 템플릿을 사용하세요!
cd existing_repo
git remote add origin https://gitlab.com/cryptoadvocate/dcsgonefwbsp.git
git branch -M main
git push -uf origin main
GitLab에 내장된 지속적 통합(CI)을 사용하세요.
이 README를 직접 만들 준비가 되셨다면, 이 파일을 편집하고 아래의 편리한 템플릿을 사용하세요(원하는 대로 자유롭게 구조화하셔도 됩니다 - 이것은 단지 시작점일 뿐입니다!). 이 템플릿을 제공해 주신 makeareadme.com에 감사드립니다.
모든 프로젝트는 다르므로, 이 중 어떤 섹션이 여러분의 프로젝트에 적용되는지 고려하세요. 템플릿에 사용된 섹션은 대부분의 오픈 소스 프로젝트에 대한 제안 사항입니다. 또한 README가 너무 길고 상세할 수 있지만, 너무 짧은 것보다는 너무 긴 것이 낫다는 점을 명심하세요. README가 너무 길다고 생각되면 정보를 생략하기보다는 다른 형태의 문서를 활용하는 것을 고려하세요.
프로젝트에 대해 스스로 설명하는 이름을 선택하세요.
사람들에게 귀하의 프로젝트가 구체적으로 무엇을 할 수 있는지 알리세요. 컨텍스트를 제공하고 방문자가 익숙하지 않을 수 있는 참조에 대한 링크를 추가하세요. 기능 목록 또는 배경 하위 섹션도 여기에 추가할 수 있습니다. 프로젝트에 대한 대안이 있다면, 차별화 요소를 나열하기에 좋은 곳입니다.
일부 README에서는 프로젝트의 모든 테스트가 통과하는지 여부와 같은 메타데이터를 전달하는 작은 이미지를 볼 수 있습니다. Shields를 사용하여 README에 추가할 수 있습니다. 많은 서비스에서 배지 추가에 대한 지침도 제공합니다.
만드는 내용에 따라 스크린샷이나 비디오를 포함하는 것이 좋을 수 있습니다(실제 비디오보다 GIF를 자주 볼 수 있습니다). ttygif와 같은 도구가 도움이 될 수 있지만, 더 정교한 방법을 위해 Asciinema를 확인해 보세요.
특정 생태계 내에서는 Yarn, NuGet 또는 Homebrew와 같은 일반적인 설치 방법이 있을 수 있습니다. 그러나 README를 읽는 사람이 초보자이고 더 많은 지침을 원할 가능성을 고려하세요. 구체적인 단계를 나열하면 모호함을 제거하고 사람들이 가능한 한 빨리 프로젝트를 사용할 수 있게 됩니다. 특정 프로그래밍 언어 버전이나 운영 체제와 같은 특정 컨텍스트에서만 실행되거나 수동으로 설치해야 하는 종속성이 있는 경우 요구 사항 하위 섹션도 추가하세요.
예제를 자유롭게 사용하고 가능하면 예상 출력을 보여주세요. README에 포함하기에 너무 긴 경우 더 정교한 예제에 대한 링크를 제공하면서, 시연할 수 있는 가장 작은 사용 예제를 인라인으로 포함하는 것이 도움이 됩니다.
사람들이 도움을 받을 수 있는 곳을 알려주세요. 이슈 트래커, 채팅방, 이메일 주소 등의 조합이 될 수 있습니다.
향후 릴리스에 대한 아이디어가 있다면 README에 나열하는 것이 좋습니다.
기여를 받을 의향이 있는지와 기여를 수락하기 위한 요구 사항을 명시하세요.
프로젝트를 변경하려는 사람들을 위해 시작하는 방법에 대한 문서가 있으면 도움이 됩니다. 실행해야 하는 스크립트나 설정해야 하는 환경 변수가 있을 수 있습니다. 이러한 단계를 명확하게 설명하세요. 이 지침은 미래의 자신에게도 유용할 수 있습니다.
코드를 린트하거나 테스트를 실행하는 명령어도 문서화할 수 있습니다. 이러한 단계는 높은 코드 품질을 보장하고 변경 사항이 의도치 않게 무언가를 손상시킬 가능성을 줄이는 데 도움이 됩니다. 테스트 실행에 대한 지침은 브라우저에서 테스트하기 위해 Selenium 서버를 시작하는 등 외부 설정이 필요한 경우 특히 유용합니다.
프로젝트에 기여한 사람들에게 감사를 표하세요.
오픈 소스 프로젝트의 경우 라이선스 방식을 명시하세요.
프로젝트에 대한 에너지나 시간이 부족하다면 README 상단에 개발 속도가 느려지거나 완전히 중단되었음을 알리는 메모를 추가하세요. 누군가가 프로젝트를 포크하거나 유지 관리자 또는 소유자로 자원하여 프로젝트를 계속 진행할 수 있습니다. 유지 관리자에 대한 명시적인 요청을 할 수도 있습니다.