Java Project 뜯어 고치기 - #3

Java Project 뜯어 고치기도 막바지를 향해 달려가고 있습니다!

어제 있었던 문제도 바로 해결했습니다.

문제는 바로! .dll 파일을 찾기 못해서 그랬던 것이었구요

파일을 추가해주니 정상 동작했어요😀

프로젝트를 뜯어 고치면서

• Gradle을 사용해 IDE에 독립적인 빌드 스크립트 작성
• 빌드 결과물은 일단 Executable JAR를 목표로 하고, 가능하다면 exe 파일까지
• README.md 이쁘게 작성
• (매뉴얼 작성)
• 제대로 되는지 테스트 완료되면, 다른 프로젝트에도 동일하게 적용

이렇게 다섯개를 목표로 삼았는데, README.md랑 매뉴얼 작성만 남았네요! 아주 좋습니다.

이 프로젝트는 사용 방법이 생각보다 아주 간단해서 매뉴얼이라고 불릴게 있을까 싶지만

다른 프로젝트들은 매뉴얼을 작성해야 할거라서

실행하는 방법이랑 input, output file 정도만 README에 명시해두고 실제 parameter 세팅 같이 복잡한 내용은 매뉴얼로 빼두려고 합니다

 

어제 이후로 작업한 내용은 딱히 없고

jre를 통째로 담아서 올리는게 아무래도 용량 측면에서 너무 안좋아보여서

그냥 사용자 로컬에 있는 jre를 쓰라고 명시할 예정입니다.

그 내용을 gradle.build에 적어주었구요.

 

가장 열심히 한건 README를 작성하는 것!

README가 잘 작성된 프로젝트를 보면 괜시리 믿음이 더 가더라구요!

그리고 제 프로그램이 부족할수록 README라도 열심히 적어야 하지 않을까 하는 생각이 들어서

최대한 이쁘게 작성해보려고 했습니다.

최근에 많이 보고 있는 docker-elk 프로젝트 README가 이뻐서 참고하려고 했는데

요 배지가 너무너무너무 이쁜거에요.... 별로 중요한건 아닌데 쓸데없는데에 꽂혀가지고는....

그래서 또 구글링해서 저 배지는 도대체 어떻게 만드나 열심히 찾아봤습니다.

간단하게 요약해보면

Shields.io: Quality metadata badges for open source projects

일단 위 사이트에 들어갑니다. 여기 사람들이 미리 만들어놓은 배지 양식들이 많아요.

근데 사실 생각보다 잘 이해가 안가서😁

사이트에서 스크롤을 쭉 내리면 아래에 YOUR BADGE라고 되어있는 부분이 있어요.

어차피 복잡한 배지를 만들게 아니니까, 여기에 값을 채워넣는 정도로도 충분하더라구요.

그리고 로고가 필요하다면

Simple Icons

이 사이트에서 가져다가 쓰면 되는 것 같았습니다.

제가 쓴 마크다운 문법을 적는게 더 명확히 설명할 수 있을 것 같은데

[![Gradle](https://img.shields.io/badge/-gradle-02303A?style=flat&logo=gradle)](https://gradle.org/)
[![Dependencies](https://img.shields.io/badge/dependencies-jinput-brightgreen?style=flat)](https://github.com/jinput/jinput)

양식을 요약해보면

[](LINK)

대문자로 적은 부분에 원하는 값을 채워넣으시면 되는 구조입니다!

첫 번째 배지처럼 LABEL위치에 아무것도 적지 않으시면 메시지만 뜹니다.

COLOR위치에는 shidlds.io에서 정의해놓은 색을 넣어도 되지만 원하는 색이 있으시다면 헥스코드에서 #을 지우고 넣어주시면 됩니다.

LOGO의 경우에는, 위 사이트에서 검색 결과가 다음과 같다면

gradle, Gradle, GRADLE 모두 작동하는걸 보니 대소문자를 무시하고 일치하는 로고를 연결해주는 것 같네요!

이렇게 쓸데없는데에 시간을 열심히 쓰고!

docker-elk의 양식을 참고해서 링크도 열심히 달아주면서 만든 README.md입니다😁😁😁

그래들 뱃지 진짜 이쁘죠... 그래들은 볼때마다 로고가 너무 귀여워요

부족한 영어로 쓰려니 시간이 너무 오래 걸리네요😢😢😢😢😢

그래도 깃에 올리는데 한글로 올리기 싫어서... 영차영차 하면서 차근차근 채워나가볼 생각입니다.

 

이 시리즈는 여기서 마무리해보려고 합니다!

이제 남은 일은 README와 매뉴얼 작성 노가다인데 딱히 글로 설명할 건 없을 것 같아서!

마지막으로 프로젝트 링크를 걸어두고 이만 물러가봅니다😀

GitHub - ytbeom/controller-input-test