# -*- mode: org; coding: utf-8 -*-
mikutter - simple, powerful and moeful twitter client
file:core/skin/data/icon.png
全てのミク廃、そしてTwitter中毒者へ贈る、至高のTwitter Clientを目指すTwitter Client。
略して至高のTwitter Client。

* 用件

** 必須アプリケーション:
- ruby (1.9.3 - 2.1.1)
- ruby gtk (2.2.0)
- rcairo (1.12.9)
- Open SSL

** プラグインが必要とするもの(必須ではない):
- notify-sendコマンド(ubuntuでは、sudo apt-get install libnotify-bin)
- aplayコマンド(サウンド通知のため・ubuntuなら最初から入ってる)

* OS/ディストリ別インストール方法
** Ubuntu 12.04でのインストール方法
   1. aptでインストール
      1. まず、パッケージをすべて最新にします
         : $ sudo apt-get update
         : $ sudo apt-get upgrade
      2. mikutterに必要なパッケージをインストールします
         : $ sudo apt-get install ruby1.9.1 ruby1.9.1-dev libnotify-bin
   2. バージョンの確認
      以下のコマンドを実行してください。
      : $ ruby -v
      ubuntu 12.04 では、単に apt-get で ruby というパッケージを入れると、 ruby1.8 が入ってしまい、 ruby コマンドでは ruby1.8 が起動してしまいます。その場合は以下のように、1.9.1をつけて起動します。
      : $ ruby1.9.1 mikutter.rb
	  同様に、gemはgem1.9.1、bundleはbundle1.9.1です。
      [[common settings][共通の設定]]へ

** その他のディストリビューション
   基本的には、その他のディストリでは、同等のライブラリが配布されていたらそれを使ってください。
   また、ディストリによってはmikutterが公式リポジトリに含まれていることがあります。

** Mac OS X
   [[http://sites.google.com/site/yorufukurou/]]

** Windows
   [[http://janetter.net/jp/]]

** iOS端末(iPhone等)
   http://tapbots.com/software/tweetbot/

** Android
   http://yuzuki.hachune.net/wiki/MikutterInstallBattle/Android

** 共通の設定 # <<common settings>>
   必要なライブラリをインストールします。割と時間がかかります。

   : $ sudo gem install bundler
   : $ bundle install --path=vendor/bundle

   以上でインストールは終了です。

** 起動
   単純に、以下のようなコマンドで実行できます。
   : $ ruby mikutter.rb

* ディレクトリ構成
  - mikutter.rb 本体起動スクリプト
  - core/ CHIのコアファイル。この下はめんどくさいから説明しません
  - plugin/ サードパーティー製プラグイン
  - skin/ スキン

* 生成されるファイルとその意味
  mikutterが生成するファイルは ~/.mikutter 以下に全て配置されます。

| ファイル名 | 説明                                                     |
|------------+----------------------------------------------------------|
| cache/     | Twitter API、アイコンなどのレスポンスのキャッシュ。       |
| settings/  | 設定やアカウント情報など  |
| logs/      | エラーログなど                                           |
| tmp/       | 一時ファイル                                             |

各ファイルは、ない場合はすべて自動生成されます。
キャッシュファイルなどを掃除したい場合は、以下のようなコマンドを使用します。

: $ mikutter --clean

これで、削除しても構わないファイルが全て削除されます。

* リンク
** mikutter
   [[http://mikutter.hachune.net/]]
   ネタで改良されていっている究極のクライアント
** hachune.net
   [[http://hachune.net/]]
   奇跡のドメイン
** Project みくんちゅ♪
   [[http://mikunchu.wiki.fc2.com/]]
   みくかわいいよみく

* ライセンスなど
** ライセンス
Copyright (C) 2009-2014 Toshiaki Asai

This software is released under the MIT License, see LICENSE

このソフトウェアは MIT ライセンスの下で公開されています。 LICENSE を参照してください。

なお、mikutter上で動作するプラグイン及び添付されている外部ライブラリ(vendor以下の全て)については、このライセンスの適応対象外です。

スキンファイル(core/skin/以下の全て)に含まれる画像及び音声は[[http://creativecommons.org/licenses/by-sa/3.0/deed.ja][クリエイティブ・コモンズ 表示 - 継承 3.0 非移植 ライセンスの下に提供されています]]。
** 連絡先
  作者(toshi_a)には、ツイッターのリプライで連絡して下さい。だいたい連絡がつくと思います。
  また、ハッシュタグ #mikutter に、mikutter関連のことを気軽につぶやいてください。Twitterらしく
  適当に参考にします。

  @toshi_a [[http://twitter.com/toshi_a]]
  [[toshi.alternative@gmail.com]]
