Learn Vimscript The Hard Way - 55. Distribution

distribution

이제 당신은 다른 많은 사람들이 유용하다고 생각갈 만한 빔 플러그인을 만들 수 있는 vimscript skill을 익혔다. 이 챕터는 그 플러그인을 어떻게 올려 다른 사람들이 쉽게 사용할 수 있게 할지에 관해 다룰 것이다.

Hosting

가장 먼저 할 일은 플러그인을 온라인에 올려 사람들이 다운로드 할 수 있게 하는 것이다. vim plugin이 사는 canonical place는 vim 웹사이틔의 scritp secion이다

웹사이트를 위해서는 계정이 필요하다. 이는 아주 간단하다.

최근 몇 년 간 플러그인을 배포하는 트렌드는 Bitbucket이나 Github같은 퍼블릭 레파지토리에 배포하는 것이다. 이른 방식이 유행이 된 데에는 두가지 이유가 있다. 먼저 pathogen같은 플러그인 매니저가 플러그인의 코드를 독립된 위치에 유지하기 쉽게 하였다. Mecurial과 Git 같은 버전 컨트롤 시스템과 Bitbucket과 Github같은 public hosting 사이트의 부상이 또 하나의 이유라고 할 수 있다.

레파지토리를 제공하는 것은 각각의 사람들이 dotfile을 version-controlled 레파지토리에 공유하는 것을 쉽게 해 준다. Mecurial 사용자는 머큐리얼의 "subrepository"를, Git 사용자는 submodule을 사용할 수 있다.

각각의 플러그인을 설치할 떄 전체 레파지토리를 받는 것은 뭔가 잘못되었을 때 디버깅을 쉽게 해 준다. VSC가 제공해 주는 blame, bisection과 같은 많은 툴을 사용할 수 있다. 이미 레파지토리를 가지고 있기 때문에 기여도 쉽게 할 수 있다.

Documentation

당신은 Vim의 내부 help format에 맞춰서 document를 작성하였지만 아직 모든 작업이 끝나지는 않았다. 몇몇 것들에 대한 간단한 서버리가 더 필요하다.

1. 이 플러그인은 무엇에 관한 것인가?
2. 사용자는 무엇을 사용하고 싶어할 것인가?
3. (만약 있다면) 다른 플러그인과 비교하여 무엇이 나은가?
4. 라이센스는 무엇인가?
5. vim-doc website에 렌더링 된 full documentation으로의 링크

이것들이 README 파일과 Vim.org의 플러그인 설명에 들어가야 한다

스크린샷을 추가하는 것도 좋은 아이디어이다.

Publicity

만약 당신의 플러그인이 준비를 마치고 다양한 웹의 위치에 정착했다면, 이제 세상에 알릴 차례이다. Twitter 팔로어들에게 알리거나, Reddit의 /r/vim 섹션에 공유하고, 개인의 블로그 등에 쓰거나 vim mailing list에 공지하자.

이제 릴리즈가 되면 칭찬이나 비판을 받을 것이다. 너무 부정적인 단어에 크게 개의치 말고 그들이 하는 말을 들어보자. 누구나 완벽하지 않다.

Exercises

• Create an account on Vim.org if you don't already have one.

• Look at the README files for some of your favorite plugins to see how they're structured and what kind of information they include.