본문 바로가기
제니의 개발일지/도움이 되었던 것 정리

Git Hub README.md 작성법

by 제니운 2022. 8. 3.
728x90

✅ README.md 작성법

 

1️⃣ file-tree-generator

 

항해를 시작한 노베이스의 나같은 초보 개발자들은 이 기능을 꼭 알면 좋겠다! 구글링을 통해 배운 건데, README 작성할 때 괜히 *, **, > 이런 기능 안 넣어도 폴더 구조 굉장히 이쁘게 만들 수 있다.

 

 

🔹 Visual Studio Code 들어가서 왼쪽 확장프로그램에 fire-tree-generator를 설치한다!

 

🔹 폴더구조 모양 보여주고 싶은 폴더 오른쪽 클릭 해서 Generate to tree를 누른다! 나는 src 폴더를 구성했다.

 

 

generate to tree 모양

 

그럼 이렇게 알아서 폴더 구조 만들어준다!

얼마나 쉬운지 ㅠㅠ README 작성 편하게 하자!!

 

 

🔹 위 내용을 복사하되, README에 붙여넣기 하고 ```bash 붙여넣고 ``` 를 꼭 입력해주어야, 이 모양 그대로 붙여넣기 할 수 있다.

 

```bash



저거 위에 내용 붙여넣고



```

 

 

이렇게 하면

 

README.md에서 보이는 모습

 

진짜 너무 이쁘게 폴더 구조 만들어준다. 완전 쉽다. 그대로 따라하면 된다.

 

 

2️⃣ README.md에 내 코드 넣고 싶을 때!!

 

```c

코드 붙여넣기

```

 

위에 ```bash처럼 똑같이 ```c 해주면 되고 그러면

 

README.md에 붙여넣어진 내 코드

 

정말 쉽고 이쁘게 README.md 내용을 작성할 수 있다.

728x90