dino/README.md

75 lines
2.4 KiB
Markdown

# An unbranded Dino fork
## Screenshots
![Screenshot showing mobile form factor and OMEMO-by-default support](doc/screenshot-2.png)
![Screenshot showing a MUC room in desktip form factor](doc/screenshot-1.png)
## Features
- **OMEMO encryption set by default**.
- Portrait screen support with `libhandy`.
- Improved [`connection_manager.vala`](libdino/src/service/connection_manager.vala).
- Quote messages according to XEP-0393 Message Styling.
- Copy messages.
- Optional send button and Enter-to-send accelerator.
- Keeps using GTK3.
- Backports bugfixes and improvements from upstream (see [`BACKPORT`](BACKPORT)).
## TODO
- In order to avoid confusion, some rebranding is planned for this fork.
- Setup communication channels to report issues and improvements.
## Installation
No binary packages of this fork are provided yet. Building from source
is required for the time being.
## Build
Make sure to install all [dependencies](doc/BUILD.md).
```sh
cmake -B build
cmake --build build
```
## Resources
- [FAQ](doc/FAQ.md)
- [Supported XEPs](doc/XEPS.md)
- [How to build](doc/BUILD.md)
- [Tor support](doc/TOR.md)
- [macOS support](doc/MACOS.md)
## Contribute
- [Send a PR](https://gitea.privatedns.org/xavi/dino/pulls) or a patch
via email. The email addresses of the contributors of this fork can be
found easily by cloning the repository and inspecting its logs.
- Look at [how to debug](doc/DEBUGGING.md) Dino before you report a bug.
- Help [translating](doc/TRANSLATIONS.md) Dino into your language.
- Make a [donation](https://dino.im/#donate) to upstream. This would
also benefit us when backporting relevant bugfixes and improvements.
## License
Dino - Modern Jabber/XMPP Client using GTK+/Vala
Copyright (C) 2016-2023 Dino contributors
Copyright (C) 2022-2023 Xavier Del Campo Romero
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.