# -*- mode: org; coding: utf-8 -*-
mikutter - simple, powerful and moeful Mastodon client
file:core/skin/data/icon.png
全てのミク廃、そしてマイクロブログ中毒者へ贈る、至高のMastodonクライアントを目指すMastodonクライアント。
略して至高のMastodonクライアント。

* 要件

** 必須
- ruby :: Gemfile に記載されているRubyのバージョンを参考にしてください。

必要な gem については Gemfile および plugin/*/Gemfile を参照してください

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

* インストール方法
  MikutterInstallBattle を参照してください。

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

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

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

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

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

: $ mikutter --clean

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

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

* ライセンスなど
** ライセンス
Copyright (C) 2009-2020 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)には、Mastodonのリプライで連絡して下さい。だいたい連絡がつくと思います。
  また、ハッシュタグ [[https://social.mikutter.hachune.net/web/timelines/tag/mikutter][#mikutter]] に、mikutter関連のことを気軽につぶやいてください。

  [[https://social.mikutter.hachune.net/@toshi_a][@toshi_a]]
  [[toshi.alternative@gmail.com]]
