GitHubにヘッポコプラグインをアップしてみた。READMEが少々面倒。

GitHubにjQueryで作ったAccordionプラグインをアップしてみた。フルオープンな状態が恥ずかしい。
プラグインについては説明するまでもないくらいヘッポコなので、今回はGitメインで書きます。
ちなみに下のが今回アップしたリポジトリになります。

https://github.com/shiba-qript/Accordion

リポジトリ作成からPushまで

GitHubでユーザを作成したら、PushするためにSSH公開鍵を登録しておかなくてはなりません。
自分のホームディレクトリで

 $ ssh-keygen

をたたくと $HOME/.ssh/ にid_rsa.pubの名前で作成されるので、その内容をGitHub上の
「Account Settings」→「SSH Public Keys」→「Add public key」
にコピーすれば登録OKです。

その後作成するリポジトリを「New repository」から作成しておきましょう。

次にinitからpushまでの手順ですが、大まかに言うと

  1. git init
  2. git add
  3. git commit
  4. git remote
  5. git push

です。git remoteは一度接続すればセッションが続く限りは次以降必要ありません。(恐らく)
そしてこのあたりの手順はリポジトリを作成した際にGitHubがやさしく教えてくれるので本説明からは省略します。

READMEが面倒

GitHubのリポジトリを見ているとアップされているファイルの下にREADMEという説明が書かれていることがあります。
これはリポジトリ内の「README」というファイルが自動的に読み込まれて展開されているようでほんとによくできているなと改めてGitHubの偉大さを再確認しました。

書き方が分からなかったのでちょーーーっとだけ調べてみました。
対応している書式が以下のようです。

  • .markdown
  • .textile
  • .rdoc
  • .org (Org-mode)
  • .creole
  • .rst (reStructuredText)
  • .asciidoc
  • .pod (Perl POD)
  • .1 (groff)

READMEにそれぞれの拡張子をつけてアップすればそのフォーマットで展開されるようです。

ぶっちゃけ拡張子だけ見せられてもなんもわからへんと最初思ったのですが、「.textile」が以前に使用したことのある「Redmine」で利用される書式であることが分かり、そちらを採用することにしました。
「.texttile」の書式についてはこちら(http://www.textism.com/tools/textile/)を参照してください。

結局のところなにが面倒だったかというと、READMEでプラグインの説明を書くあたりがすごく面倒だったというお話です。(爆
でもGitHubを使っていこうと思うとこのあたりも避けて通れないので、色々ちゃんとやらなきゃなと反省しました。

ちなみにREADMEはALL EnglishでWriteする方が、Super CoolなのでEnglishもStudyしなきゃなとI think so.