Skip to content

Commit

Permalink
fdroid向けの準備、READMEを英語化
Browse files Browse the repository at this point in the history
  • Loading branch information
shiosyakeyakini-info committed Jan 29, 2024
1 parent 2d704ea commit 976b38f
Show file tree
Hide file tree
Showing 9 changed files with 143 additions and 32 deletions.
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# CONTRIBUTING GUIDES

## Translate

you can fork this repository and add your translate language or edit files in `lib/l10n` folder.
62 changes: 62 additions & 0 deletions README-ja.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
[English](https://github.com/shiosyakeyakini-info/miria/blob/develop/README.md) | 日本語

# Miria

MiriaはiOS, Android向けMisskeyクライアントです。Windowsでも動作します。

## インストール

- ストアからインストール
- [Play Store](https://play.google.com/store/apps/details?id=info.shiosyakeyakini.miria)
- [App Store](https://apps.apple.com/jp/app/miria/id6449201469)
- 最新版をGitHubからインストール
- [GitHub最新版のリリース(Windows版もあります)](https://github.com/shiosyakeyakini-info/miria/releases/latest)
- 最新版をTestFlightからインストール
- [TestFlight](https://testflight.apple.com/join/X6Q7pE98)

## 機能

- 複数サーバー、アカウント管理
- ホーム、ローカル、ソーシャル、グローバルタイムライン、リスト、アンテナ、チャンネルの表示
- ノート表示
- MFMは現在の構文のすべてに(曲がりなりにも)対応しています。
- ノート、リノート、引用リノート、任意のチャンネルへのリノート
- リアクション
- 通知の表示
- アンテナとリストの編集
- 「みつける」
- お知らせ
- お気に入り
- ノートとユーザーの検索
- 「ページ」機能(閲覧のみ)
- サーバー情報の表示(オンラインユーザー数、ジョブキュー、広告、カスタム絵文字等)


### 機能に対する制限

- Miriaはサーバー独自の機能に基本的には対応していません。
- ただし、一部の機能を独自に取り込んだり、特定のサーバー向けの実装を行っている場合があります。
- MiriaはMisskey v13以上とそれらのフォークされたサーバーでのみ動作します。
- [Sharkey](https://joinsharkey.org/)[CherryPick](https://github.com/kokonect-link/cherrypick)[もこきー](https://mkkey.net/)では動作するかもしれませんが、テストは行われていません。
- [Firefish](https://joinfirefish.org/ja/)[Catodon](https://catodon.social/)およびMastodonへは今後もサポートする予定はありません。
- MiriaはAiScript関連の機能(プラグイン、Play)は実装されていません。難しすぎるためです。
- Miriaはブラウザの機能に依存していません。
- MFMの見た目がブラウザと異なる場合があります。
- カスタムCSSは実装できません。

# コントリビュート



# ライセンス

## アイコンについて


![Miriaのアイコン](/assets/images/icon.png)

`/assets/images/icon.png` においています。

Miriaのアイコンはパブリックドメインとします。お使いのFediverseでカスタム絵文字に登録するなどの用途で自由に使用することができます。

二次創作やその他の利用もだいじょうぶです(でも拘束する根拠はないですが、R-18Gだけ避けてもらえるとうれしいです)
69 changes: 37 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,51 @@
# Miria

Miriaはスマートフォン向けMisskeyクライアントです。
EN | [日本語](https://github.com/shiosyakeyakini-info/miria/blob/develop/README-ja.md)

## コンセプト

- Misskeyをブラウザで見たときと近い世界観を構築しつつ、アプリならではの操作感にフィットできること
- シームレスに操作ができること
- MFMアートがそれなりに描画できること
# Miria

## インストール
Miria is Misskey Client App for iOS, Android and many targets which made by Flutter.

- ストアからインストール
- [Play Store](https://play.google.com/store/apps/details?id=info.shiosyakeyakini.miria)
- [App Store](https://apps.apple.com/jp/app/miria/id6449201469)
- 最新版をGitHubからインストール
- [GitHub最新版のリリース](https://github.com/shiosyakeyakini-info/miria/releases/latest)
- 最新版をTestFlightからインストール
- TestFlightはpixivFanbox経由でのURL共有としています。 [pixivFanbox](https://shiosyakeyakini.fanbox.cc/)
## Install

## 対応予定
- [Play Store](https://play.google.com/store/apps/details?id=info.shiosyakeyakini.miria)
- [App Store](https://apps.apple.com/jp/app/miria/id6449201469)
- [Download latest release from GitHub(Include Windows Version)](https://github.com/shiosyakeyakini-info/miria/releases/latest)
- [TestFlight](https://testflight.apple.com/join/X6Q7pE98)

### 対応する予定があるもの
I'm planning to deploy from F-Droid.

[issue](https://github.com/shiosyakeyakini-info/miria/issues)を対応予定のメモ欄がわりに使っています。
## Features

### 対応する予定がないもの
- Login, Logout, Management multiple servers and accounts
- Show home, local, hybrid(social), global timelines, list, antenna and channel
- Show note with MFM (Completely Supported).
- Note, Renote, Quoted renote, renote to any channel
- Reaction
- Show Notifications
- Edit antenna and list
- Explore
- Announcements
- Favorite
- Search notes and users
- Page (show only)
- Show Server Information (online users, job queue, ads, custom emojis)

- ページ、PlayなどのAiScriptが必要な機能
- これらの機能は実装がたいへん難しいので、いまのところ対応する予定はありません。
- CalckeyなどのMisskeyベースの他のSNS対応
- APIのレスポンスの型が異なるなどさまざまな制約から、現状対応する予定はありません。
- Misskeyの機能の網羅
- このアプリはMisskeyの機能を完全に網羅する予定はありません。
使用頻度の少ない機能(チャンネルの作成など)はWebと併用する使い方を想定しています。
### Limited

## アイコンについて
- Miria does not support forked server's unique features.
- Miria supports only over Misskey v13 and forked servers.
- [Sharkey](https://joinsharkey.org/), [CherryPick](https://github.com/kokonect-link/cherrypick) and [mkkey.net](https://mkkey.net/) may be available but did not test.
- [Firefish](https://joinfirefish.org/ja/), [Catodon](https://catodon.social/), Mastodon will not support in the future too.
- Miria does not support AiScript related features. (Plugin, Play)
- Miria does not depend browser features. ¥
- There are cases in which Miria's MFM appearance is different from browsers.
- Custom CSS didn't support.

# License

![Miriaのアイコン](/assets/images/icon.png)
## About Miria Icon

`/assets/images/icon.png` においています。
![Miria Icon](/assets/images/icon.png)

Miriaのアイコンはパブリックドメインとします。お使いのFediverseでカスタム絵文字に登録するなどの用途で自由に使用することができます。
Miria icons is avaiable `/assets/images/icon.png`

二次創作やその他の利用もだいじょうぶです(でも拘束する根拠はないですが、R-18Gだけ避けてもらえるとうれしいです)
Miria icons is PD(Public Domain). you can use such as registering custom-emojis to your server.
17 changes: 17 additions & 0 deletions fastlane/metadata/android/en-US/full-description.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Miria is Misskey Client App for iOS, Android and many targets which made by Flutter.

Miria includes these features.

- Login, Logout, Management multiple servers and accounts
- Show home, local, hybrid(social), global timelines, list, antenna and channel
- Show note with MFM (Completely Supported).
- Note, Renote, Quoted renote, renote to any channel
- Reaction
- Show Notifications
- Edit antenna and list
- Explore
- Announcements
- Favorite
- Search notes and users
- Page (show only)
- Show Server Information (online users, job queue, ads, custom emojis)
1 change: 1 addition & 0 deletions fastlane/metadata/android/en-US/short_description.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Miria is Msiskey Client Application.
1 change: 1 addition & 0 deletions fastlane/metadata/android/en-US/title.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Miria
18 changes: 18 additions & 0 deletions fastlane/metadata/android/ja-JP/full-description.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
MiriaはMisskey用サードパーティクライアントです。

Misskeyの機能のうち、下記の機能に対応しています。

- 複数サーバー、アカウント管理
- ホーム、ローカル、ソーシャル、グローバルタイムライン、リスト、アンテナ、チャンネルの表示
- ノート表示
- MFMは現在の構文のすべてに(曲がりなりにも)対応しています。
- ノート、リノート、引用リノート、任意のチャンネルへのリノート
- リアクション
- 通知の表示
- アンテナとリストの編集
- 「みつける」
- お知らせ
- お気に入り
- ノートとユーザーの検索
- 「ページ」機能(閲覧のみ)
- サーバー情報の表示(オンラインユーザー数、ジョブキュー、広告、カスタム絵文字等)
1 change: 1 addition & 0 deletions fastlane/metadata/android/ja-JP/short_description.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Miriaは分散型SNS「Misskey」向けサードパーティクライアントです。
1 change: 1 addition & 0 deletions fastlane/metadata/android/ja-JP/title.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Miria

0 comments on commit 976b38f

Please sign in to comment.