Github Readme를 작성해보자 - 1

Github Readme 삽질 1편

Readme?

https://docs.github.com/ko/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes

 

github readme란

 

저런식으로 github project의

설명하는 페이지를 말한다

사실 readme를 많이 안써서

html css를 지원하긴 하지만

엄청 기초적인 것만 지원하는걸

아까 처음 알았다;;;;

 

버튼을 배치해서 hover나

클릭하면 이미지를 띄우려고

했는데 안된댄다

 

그래서 github page에

동적인 페이지를 만들어두고

iframe으로 보여줄까

했는데 안된단다;;;;;;;;

 

https://gist.github.com/ihoneymon/652be052a0727ad59601

마크다운(Markdown) 사용법

이분이 내용을 잘 정리해주셔서

참고용으로 가져왔다

 

저기에 써있는 내용만 작성 가능하다

버튼..은 되는걸로 알고 있는데

어차피 javascript가 막혀있어서

무늬만 버튼이고 기능을 못한다;;;;;

 

다행히 이미지는 지원이 되니

readme에 어떻게 이미지를 넣으면

되는지 알려주겠다

 

https://imgur.com/

Imgur: The magic of the Internet

이미지를 올릴 수 있는

다양한 사이트가 있지만

난 Imgur를 이용할 것이다(그냥)

 

 

imgur 계정이 없으면 만들고

내가 필요한 이미지들을

업로드 해준다

 

업로드 한 이미지를

우클릭 해서 새 탭에서 열어주고

이미지 경로를 복사해준다

 

<img src="이미지_경로">

 

복사한 경로를 저기에

넣기만 하면 끝이다;;;;;;

 

아주 좋군???

그냥 테스트용으로 볼거면

저 왼쪽 위의 Preview를 누르자

 

 

아까 아무 생각 없이 계속 테스트 하다가

내 history 저꼴 돼서 당황했다

 

하지만 해결 방법이 있다.

일단 만약에 commit 테러..;;

때문에 pull list가 생겼다면

절대로 받지 말고 새 branch를 먼저 만든다

저거 pull 하면 branch 새로 만들어도

이미 pull을 받아버렸기 땜시 같이 따라옴

 

 

새 branch를 만들어서

그 동안의 과정을 옮겨주고

설정에 들어가서 Default branch를

새로 만든 branch로 바꿔준다

 

참고로 옆에 있는 Update를 눌러줘야함

저게 곧 저장버튼임

 

그리고 View All branch에 가서

원래 branch(Main)을 지워준다

 

저거는 내가 새 branch를 만들고

이름을 Main으로 바꾼 상태이다

 

 

암튼 readme commit 때문에

식겁해서 새 branch를 하나 만들어서

거기서 실컷 작업하고

다 완성 됐다 싶으면 main으로

가져오기로 했다

 

 

아주 좋군?

 

 

근데 background image

button image 뭐 이런식으로

이미지 위에 이미지를 얹고

배경 색 위에 아이콘을 얹고

이런 기초적인 것도 할 수 없어서

ㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋ

이미지를 저런식으로 자르고

a 태그 안에 이미지를 넣어뒀다

 

<a href="하이퍼_링크">
  <img align="left" width="99%" src="이미지_주소">
</a>
<a href="하이퍼_링크">
  <img align="left" width="99%" src="이미지_주소" >
</a>
<a href="하이퍼_링크">
  <img align="left" width="99%" src="이미지_주소" >
</a>
<a href="하이퍼_링크">
  <img align="left" width="99%" src="이미지_주소" >
</a>

 

구조는 이런식으로 매우 간단한데

카카카카캌ㅋㅋ캌캌캌ㅋㅋㅋㅋㅋㅋㅋㅋ

readme를 저런식으로 넣는 사람이

얼마나 있을까..?

 

캌카캌카카카카캌ㅋㅋ카캌캌ㅋㅋ

암튼 효과가 매우 좋다^^bbbbb