thedesk/README.md

121 lines
5.2 KiB
Markdown
Raw Normal View History

2018-01-28 23:22:43 +11:00
# TheDesk
2018-08-10 01:18:35 +10:00
2019-02-01 04:12:43 +11:00
[![Build Status](https://travis-ci.org/cutls/TheDesk.svg?branch=master)](https://travis-ci.org/cutls/TheDesk)
[![Crowdin](https://d322cqt584bo4o.cloudfront.net/thedesk/localized.svg)](https://translate.thedesk.top/project/thedesk)
2018-08-05 14:35:48 +10:00
Mastodon/Misskey client for PC(Windows/Linux/macOS)
オープンソースSNSマストドン/MisskeyのWindows/Linuxクライアント
2018-02-18 16:43:11 +11:00
Download:[TheDesk](https://thedesk.top)
Contact me(bug report...):GitHub Issues, mention to [Cutls@kirishima.cloud](https://kirishima.cloud/@Cutls) or toot with #Desk
バグレポートなど:GitHub Issuesや[Cutls@kirishima.cloud](https://kirishima.cloud/@Cutls)へのリプ,または#Deskでトゥートして下さい.
2018-01-28 23:22:43 +11:00
2019-03-16 16:08:38 +11:00
### Contribute/コントリビュート
Please make a pull request to ***WIP(before CI)*** brunch
***WIP(before CI)*** ブランチにプルリクエストをお願いします。
2018-09-18 01:02:32 +10:00
## License/ライセンス
2018-01-28 23:22:43 +11:00
2018-11-28 03:21:23 +11:00
[GNU General Public License v3.0](https://github.com/cutls/TheDesk/blob/master/LICENSE)
2018-11-28 03:21:52 +11:00
The icon is provided under [Creative Commons BY-NC-SA](https://creativecommons.org/licenses/by-nc-sa/4.0/)/アイコンは[クリエイティブ・コモンズ 表示-非営利-継承](https://creativecommons.org/licenses/by-nc-sa/4.0/)で提供されています。
2018-11-28 03:21:23 +11:00
[Press Kit](https://dl.thedesk.top/press/TheDesk+PressKit.zip)
2019-01-27 01:26:56 +11:00
2018-11-28 03:21:23 +11:00
* [PNG](https://dl.thedesk.top/press/TheDesk.png)
* [Monotone SVG](https://dl.thedesk.top/press/TheDesk.svg)
* [ico](https://dl.thedesk.top/press/TheDesk.ico)
* [icns](https://dl.thedesk.top/press/TheDesk.icns)
2018-09-18 01:02:32 +10:00
## Terms of Use/利用規約
2018-12-16 18:17:52 +11:00
* [利用規約(Terms of Use(ja))](https://thedesk.top/tos.html)
* [プライバシーポリシー(Privacy Policy(ja))](https://thedesk.top/priv.html)
2018-01-28 23:22:43 +11:00
## Language/言語
2019-01-27 01:26:56 +11:00
* 日本語(Japanese)
* English(英語)
### Translation/翻訳
2018-08-05 13:36:23 +10:00
2019-01-27 01:26:56 +11:00
Crowdin project is available! Visit: https://translate.thedesk.top
2019-01-27 01:26:56 +11:00
Crowdinから翻訳に参加してみませんか: https://translate.thedesk.top
2018-01-28 23:22:43 +11:00
## Requirement/環境
2019-01-27 01:26:56 +11:00
* Electron 3.0.10(install yourself)
* electron-dl(in package.json)
* Jimp(in package.json)
* font-manager(in package.json)
* Python 2.x(install yourself)
* VisualC++(Windows)(install yourself)
* itunes-nowplaying-mac(for macOS)(in package.json)
* node-notifier(in package.json)
* sumchecker(in package.json)
* Ability to read unformated files!(install yourself)
2018-01-28 23:22:43 +11:00
2019-03-20 22:11:03 +11:00
## Contributors/主なコントリビューター
2018-08-05 13:36:23 +10:00
macOSビルダー
2019-01-27 01:26:56 +11:00
* [とねぢ](https://minohdon.jp/@toneji)
2018-08-05 13:36:23 +10:00
2019-01-13 13:05:41 +11:00
Linuxビルダー
2019-01-27 01:26:56 +11:00
* [ぽぷんじゃ](https://popon.pptdn.jp/@popn_ja)
2019-01-13 13:05:41 +11:00
2019-03-20 22:11:03 +11:00
iTunes NowPlayingにアルバムアートワークを付けてくれた人
* [kPherox](https://www.kr-kp.com/)
2018-07-07 05:22:26 +10:00
## Build/ビルド
2018-08-05 13:36:23 +10:00
2018-07-30 21:26:06 +10:00
Misskey(misskey.xyz) application token is not in cutls/TheDesk
Misskey(misskey.xyz)のトークンは含まれておりません。
2018-12-17 01:01:25 +11:00
`git clone https://github.com/cutls/TheDesk`
`npm install electron -g`
`cd TheDesk/app`
`npm install`
2019-01-27 01:26:56 +11:00
`npm install --save-dev electron-rebuild`
2018-07-30 21:26:06 +10:00
2018-12-17 01:01:25 +11:00
Linux/macOS
`./node_modules/.bin/electron-rebuild`
Windows
`.\node_modules\.bin\electron-rebuild.cmd`
To install Python 2.x and Visual C++ for Windows, before running `npm install --save-dev electron-rebuild`
WindowsでPython 2.xやVisualC++を一発でインストールできるツールもあります(`npm install --save-dev electron-rebuild`の前に)
`npm install --global windows-build-tools`
日本語話者向けですが、macOSビルドにはXCodeが要るとの情報があります。([とねぢ](https://minohdon.jp/@toneji)氏談)
2019-04-13 02:49:22 +10:00
### electron-builder
`electron-builder --target`
`target`は`win`か`linux`か`mac`を指定してください。
Config is all on package.json
ビルド設定はすべてpackage.jsonに記載しています。
2018-12-16 18:17:52 +11:00
### electron-packager
2019-01-27 01:26:56 +11:00
2018-07-07 05:22:26 +10:00
Windows
2019-02-27 12:17:35 +11:00
`electron-packager ./app TheDesk --executable-name="TheDesk" --app-copyright="Copyright (c) TheDesk 2018 Cutls.com 2015 All Right Reserved" --win32metadata.CompanyName="TheDesk&Cutls.com" --win32metadata.FileDescription="TheDesk" --win32metadata.OriginalFilename="TheDesk" --win32metadata.InternalName="TheDesk" --win32metadata.ProductName="TheDesk" --platform=win32 --arch=all --electron-version=4.0.5 --icon=.\app\thedesk.ico --overwrite`
2018-07-07 05:22:26 +10:00
Linux
2019-02-27 12:17:35 +11:00
`electron-packager ./app TheDesk --executable-name="TheDesk" --app-copyright="Copyright (c) TheDesk 2018 Cutls.com 2015 All Right Reserved" --platform=linux --arch=x64,ia32 --electron-version=4.0.5 --overwrite`
2018-07-07 05:22:26 +10:00
macOS
2019-02-27 12:17:35 +11:00
`electron-packager ./app TheDesk --executable-name="TheDesk" --app-copyright="Copyright (c) TheDesk 2018 Cutls.com 2015 All Right Reserved" --platform=darwin --arch=all --electron-version=4.0.5 --icon=./app/icon.icns --overwrite`
2018-07-07 05:22:26 +10:00
2019-02-01 03:30:25 +11:00
## Pleroma support
Did you find a bug with Pleroma accounts?
Pleroma **does not** follow Mastodon API rules completely although Pleroma developers say so.
Please write issues to improve TheDesk affinity with Pleroma.
Pleromaは、Mastodon APIとの互換性を謳っていますが、実際には様々な差異があり、TheDeskで不具合が発生することがあります。
Issuesに書いてある問題についてはなるべく対処しますので、ぜひお知らせください。
2018-01-28 23:22:43 +11:00
## See also/詳しく
2018-08-17 03:21:40 +10:00
[TheDesk - マストドン日本語ウィキ](https://ja.mstdn.wiki/TheDesk)