Whalebird-desktop-client-ma.../README.md

107 lines
3.5 KiB
Markdown
Raw Normal View History

2023-12-02 07:21:25 +01:00
# Whalebird
[![Build](https://github.com/h3poteto/whalebird-desktop/actions/workflows/build.yml/badge.svg)](https://github.com/h3poteto/whalebird-desktop/actions/workflows/build.yml)
[![GitHub release](http://img.shields.io/github/release/h3poteto/whalebird-desktop.svg)](https://github.com/h3poteto/whalebird-desktop/releases)
[![Mac App Store](https://img.shields.io/itunes/v/6445864587)](https://apps.apple.com/us/app/whalebird/id6445864587)
[![AUR version](https://img.shields.io/aur/version/whalebird)](https://aur.archlinux.org/packages/whalebird/)
2023-12-02 07:54:24 +01:00
[![Crowdin](https://badges.crowdin.net/whalebird-desktop/localized.svg)](https://crowdin.com/project/whalebird-desktop)
2018-03-07 14:28:48 +01:00
2023-12-02 07:21:25 +01:00
Whalebird is a Fediverse client app for desktop.
2018-08-15 08:38:17 +02:00
2023-12-02 07:21:25 +01:00
## Feature
- An interface like slack
- Notify to desktop
- Streaming
- Manage multiple accounts
- Supporting
- Mastodon
- Pleroma
- Friendica
- Firefish
## Install
### Mac
[![App Store](app-store.svg)](https://itunes.apple.com/us/app/whalebird/id1378283354)
Or you can download `.dmg` from [release page](https://github.com/h3poteto/whalebird-desktop/releases).
So on, you can install from Homebrew:
```
$ brew update
$ brew install --cask whalebird
2018-08-15 08:38:17 +02:00
```
2018-03-22 17:06:49 +01:00
2023-12-02 07:21:25 +01:00
:sparkles: Thanks to [@singingwolfboy](https://github.com/singingwolfboy) for adding it to [homebrew-cask](https://github.com/Homebrew/homebrew-cask/blob/cf568882b6e012956ca404a16be2db36ca873002/Casks/whalebird.rb).
### Linux
There are some packages in [release page](https://github.com/h3poteto/whalebird-desktop/releases), for example `.deb`, `.rpm` and `.AppImage`.
If you do not want to use the package manager, please download `.tar.bz2` file and decompress it.
If you are using snap, please install from [snapcraft.io](https://snapcraft.io/whalebird).
2023-12-02 07:21:25 +01:00
```
$ sudo snap install whalebird
```
2018-05-15 02:08:37 +02:00
2023-12-02 07:21:25 +01:00
If you are using flatpak, please install from
[flathub.org](https://flathub.org/apps/details/social.whalebird.WhalebirdDesktop).
2023-04-15 01:52:00 +02:00
```
2023-12-02 07:21:25 +01:00
$ flatpak install social.whalebird.WhalebirdDesktop
```
2023-04-15 01:52:00 +02:00
2023-12-02 07:21:25 +01:00
Or you can install from [Arch User Repository](https://aur.archlinux.org/packages/whalebird/).
```
2023-12-02 07:21:25 +01:00
$ yay -S whalebird
```
### Windows
<a href="https://apps.microsoft.com/store/detail/whalebird/9NBW4CSDV5HC"><img src="./windows-store.svg" alt= "Windows Store" width="156" height="auto"></a>
2023-03-08 16:18:11 +01:00
2023-12-02 07:21:25 +01:00
We prepared winget package and `.exe` [files](https://github.com/h3poteto/whalebird-desktop/releases), **but we don't recommend these ways**.
Because these binary is not code signed, so you will get warnings when you launch. Only Windows Store version is signed, so please use it.
```
$ winget show "Whalebird" --versions
2023-03-08 16:18:11 +01:00
```
2018-03-22 17:06:49 +01:00
2023-12-02 07:21:25 +01:00
## Translation
2023-12-02 07:54:24 +01:00
If you can speak multiple languages, could you please help with translation in [Crowdin](https://crowdin.com/project/whalebird-desktop)?
2023-12-02 07:21:25 +01:00
Or if you want add new language, please create an issue. I will add it.
## Development
We'd love you to contribute to Whalebird.
### Minimum requirements for development
* Node.js greater than or equal version 15.0.0 (18.x is recommended)
* npm or yarn
### Getting started
``` bash
# clone this repository
$ git clone https://github.com/h3poteto/whalebird-desktop.git
$ cd whalebird-desktop
# Install font config
$ sudo apt-get install libfontconfig-dev
# install dependencies
$ yarn install
# serve with hot reload at localhost:9080
$ yarn run dev
2018-03-22 17:06:49 +01:00
```
2023-12-02 07:21:25 +01:00
# License
The software is available as open source under the terms of the [GPL-3.0 License](https://www.gnu.org/licenses/gpl-3.0.en.html). However, icons do not comply with this license, © Miho Fukuda.