diff --git a/README-WIN64.md b/README-WIN64.md deleted file mode 100644 index 15666e05..00000000 --- a/README-WIN64.md +++ /dev/null @@ -1,56 +0,0 @@ -![Dino (WIN64)](https://dino.im/img/readme_header.svg) -======= - -![screenshots](https://dino.im/img/screenshot-main.png) - -Build on Windows (x86_64) ------------- -- Install and configure the [MSYS2](https://www.msys2.org/) package; -- Go to `MINGW64` environment; -- Clone project: - ```sh - git clone https://github.com/mxlgv/dino && cd dino - ``` -- Run the script to install dependencies: - ```sh - ./build-win64.sh --prepare - ``` -- Start the build (the builded distribution is available in the `windows-installer/dist-win64` folder): - ```sh - ./build-win64.sh - ``` -Note: the build script has some other options, their description can be found using the `--help`. - -Build Windows Installer (NSIS) ------------- -Before this, you must build the project according to the instructions above. It's worth making sure that `windows-installer/dist-win64` is not empty. -Now you should run: -```sh -./build-win64.sh --build-installer -``` - -The builded installer will be available in the directory `windows-installer/dino-installer.exe`. - -Resources ---------- -- Check out the [Dino website](https://dino.im). -- Join our XMPP channel at `chat@dino.im`. -- The [wiki](https://github.com/dino/dino/wiki) provides additional information. - -License -------- - Dino - Modern Jabber/XMPP Client using GTK+/Vala - Copyright (C) 2016-2023 Dino contributors - - 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 . diff --git a/README.md b/README.md index c253c37e..39ee9e7d 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,43 @@ -![Dino](https://dino.im/img/readme_header.svg) +This is Dino+
+A modern XMPP/Jabber client software, based on [Dino](https://github.com/dino/dino/) ======= ![screenshots](https://dino.im/img/screenshot-main.png) +Project description +------------ +Dino+ is a fork of [Dino](https://github.com/dino/dino), a modern XMPP/Jabber client written in Vala using GTK+, which includes a few relatively minor but important quality-of-life features. + +It was created due to upstream project's maintainers being seemingly unwilling to accept PRs from the community. As of March 2024, there are over 50 PRs pending, most of which are silently ignored. + +Some of the features that Dino+ implements: + +* Windows support +* Chat history "scroll-to-load" (both for 1-on-1 chats and MUCs), much like Conversations and Gajim +* Forced MAM sync for MUCs +* Password change via GUI +* Some additional QoL-features + +What's currently in the works: + +* Migrate build to Meson +* Fixes for sound notifications on KDE and some GTK-based platforms +* MacOS support for Mac silicon + +Dino+ is currently to be considered an alpha-quality product. Please open an issue or send a PR if you find or fix any issues. + +OS support +------------ +* Linux (flatpaks are targeted for Ubuntu 22.04+) +* Windows 10\11 + +We only support 64 bit platforms. + Installation ------------ -Have a look at the [prebuilt packages](https://github.com/dino/dino/wiki/Distribution-Packages). +Have a look at our [releases](https://github.com/mxlgv/dino/releases). -Build +Build on Linux ----- Make sure to install all [dependencies](https://github.com/dino/dino/wiki/Build#dependencies). @@ -15,23 +45,55 @@ Make sure to install all [dependencies](https://github.com/dino/dino/wiki/Build# make build/dino +Build on Windows (x86_64) +------------ +- Install and configure the [MSYS2](https://www.msys2.org/) package; +- Go to `MINGW64` environment; +- Clone project: + ```sh + git clone https://github.com/mxlgv/dino && cd dino + ``` +- Run the script to install dependencies: + ```sh + ./build-win64.sh --prepare + ``` +- Start the build (the builded distribution is available in the `windows-installer/dist-win64` folder): + ```sh + ./build-win64.sh + ``` +Note: the build script has some other options, their description can be found using the `--help`. + +Build Windows Installer (NSIS) +------------ +Before this, you must build the project according to the instructions above. It's worth making sure that `windows-installer/dist-win64` is not empty. +Now you should run: +```sh +./build-win64.sh --build-installer +``` + Resources --------- -- Check out the [Dino website](https://dino.im). -- Join our XMPP channel at `chat@dino.im`. -- The [wiki](https://github.com/dino/dino/wiki) provides additional information. +- Original project's [website](https://dino.im). +- Dino's chat room `chat@dino.im` (please don't post there any issues related to this fork!) +- The upstream project's [wiki](https://github.com/dino/dino/wiki) provides additional information. Contribute ---------- -- Pull requests are welcome. [These](https://github.com/dino/dino/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) might be good first issues. Please discuss bigger changes in our channel first. +- Pull requests are welcome! - Look at [how to debug](https://github.com/dino/dino/wiki/Debugging) Dino before you report a bug. - Help [translating](https://github.com/dino/dino/wiki/Translations) Dino into your language. -- Make a [donation](https://dino.im/#donate). + +Special thanks +---------- +We'd like to thank all of the contributors whom provided the PRs used in this project. + +We also recognise the previous efforts of [LAGonauta](https://github.com/LAGonauta) without whom Windows build wouldn't be available. License ------- - Dino - Modern Jabber/XMPP Client using GTK+/Vala + Dino+, a modern XMPP/Jabber client software based on Dino Copyright (C) 2016-2023 Dino contributors + Copyright (C) 2024 Dino+ contributors 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