diff options
| author | Xavier Del Campo Romero <xavi.dcr@tutanota.com> | 2023-09-29 00:00:08 +0200 |
|---|---|---|
| committer | Xavier Del Campo Romero <xavi.dcr@tutanota.com> | 2023-10-01 21:28:23 +0200 |
| commit | ac39f88d1c5a9d46ee5f61d2dc10468285b67a39 (patch) | |
| tree | 90803ebea00b67755317d1ac9c2f09d527b795ed | |
| parent | d1f04bf33ed4e2b6f17bdc32784aa23c6dfd6a20 (diff) | |
| download | dino-ac39f88d1c5a9d46ee5f61d2dc10468285b67a39.tar.gz | |
README.md: Update for fork
| -rw-r--r-- | README.md | 80 |
1 files changed, 48 insertions, 32 deletions
@@ -1,37 +1,53 @@ - -======= - - - -Installation ------------- -Have a look at the [prebuilt packages](https://github.com/dino/dino/wiki/Distribution-Packages). - -Build ------ -Make sure to install all [dependencies](https://github.com/dino/dino/wiki/Build#dependencies). - - ./configure - make - build/dino - -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. - -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. -- 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). - -License -------- +# An unbranded Dino fork + +## Features + +- Keeps using GTK3. +- Includes some features that did not make into upstream. +- Backports bugfixes and improvements from upstream. + +## 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-2022 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 |