diff --git a/INSTALL.md b/INSTALL.md deleted file mode 100644 index 0311120436..0000000000 --- a/INSTALL.md +++ /dev/null @@ -1,42 +0,0 @@ -# kmyblueインストール手順 - -## 共通の注意事項 - -### 必須ソフトウェアのバージョン - -Ruby、ElasticSearch、ImageMagick、PostgreSQLなど必須ソフトウェアのバージョンは、本家Mastodonに準じます。リリースノートに対応する本家Mastodonバージョンが記載されていますので、本家Mastodonのリリースノートから対応するバージョンを探して調べてください。 - -### 一般的な注意事項 - -kmyblueは頻繁にバージョンアップを行います。 - -- 本家Mastodonの開発中のバージョンを平然と取り込みます -- バグが含まれていることがあります -- 特に最新コミットでは、デバッグ用コードや、`kmy.blue`本番サーバーで動作確認を行うためのコードが含まれている場合があります。ブランチの最新コミットではなく最新タグを取り込むことを強くおすすめします - -Mastodonの最新バージョンでは、`dist`フォルダに`mastodon-streaming@.service`が追加されています。これは現在の一般的な手順書には存在しません。各サービスファイルをコピーするとき、`mastodon-streaming@.service`をコピーし忘れないようにしてください。 - -### ElasticSearchを使用する場合 - -kmyblueでは、sudachiの使用を前提としています。 - -下記URLより、ElasticSearchにSudachiプラグインを追加してください。 -ただし辞書ファイル（sudachi dictionary archive）は手順書で指示されたパスではなく`/etc/elasticsearch/sudachi`に格納してください。 - -https://github.com/WorksApplications/elasticsearch-sudachi - -Sudachiインストール終了後、追加で`/etc/elasticsearch/sudachi/config.json`に下記を記述して保存してください。`system_full.dic`を使用する場合は適宜`systemDict`プロパティの内容を置き換えてください。 - -```json -{ - "systemDict": "system_core.dic" -} -``` - -## インストール手順 - -[Wiki](https://github.com/kmycode/mastodon/wiki/Installation)を参照してください - -## アップデート手順 - -[Wiki](https://github.com/kmycode/mastodon/wiki/Updation)を参照してください diff --git a/README.md b/README.md index 7eb752f1a2..5620e7069c 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ kmyblueは、特に未収載投稿の検索が強化されているため、ロ ## インストール方法 -INSTALL.mdや[Wiki](https://github.com/kmycode/mastodon/wiki/Installation)を参照してください。 +[Wiki](https://github.com/kmycode/mastodon/wiki/Installation)を参照してください。 ## 開発への参加方法 @@ -52,6 +52,7 @@ kmyblueは絵文字リアクションに対応しているフォークの１つ - **main** - 管理者が本家MastodonにPRするときに使うことがあります - **kb_development** - 現在kmyblue本体で使われているソースコードです - **kb_lts** - LTSの管理に使います。LTSはこのブランチから公開されます +- **kb_patch** - 修正パッチの管理に使います。マイナーバージョンアップデートは通常このブランチから公開されます - **kb_migration** - 本家Mastodonへの追従を目的としたブランチです。`kb_development`上で開発を進めているときに利用します - **kb_migration_development** - 本家Mastodonへ追従し、かつその上で開発するときに使うブランチです。最新の本家コードでリファクタリングが行われ、`kb_development`と`kb_migration`の互換性の維持が困難になったときに利用します。ここで追加された機能は原則、本家Mastodonのバージョンアップと同時に`kb_development`に反映されます