1
0
mirror of https://github.com/qTox/qTox.git synced 2024-03-22 14:00:36 +08:00
qTox/README.md
Zetok Zalbavar ce9406c959
docs: move Reviews section and add Testing PRs section
Since anyone, not just maintainers can review PRs.
2016-10-25 08:59:49 +01:00

113 lines
4.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

qTox
======
[**User Manual**](/doc/user_manual_en.md) **|**
[**Install**](/INSTALL.md) **|**
[**Help us**](#help-us) **|**
[**Report bugs**](https://github.com/qTox/qTox/wiki/Writing-Useful-Bug-Reports) **|**
[**Translate**](/translations/README.md) **|**
[**Jenkins builds**](https://build.tox.chat/) **|**
[**Mailing list**](https://lists.tox.chat) **|**
**IRC Channel:** [#qtox@freenode]
**qTox is a powerful Tox client that follows the Tox design guidelines while
running on all major platforms.**
----
* **Windows**:
- **[64 bit installer]** - [*signature*](https://qtox-win.pkg.tox.chat/qtox/win64/setup-qtox.exe.asc)
- **[32 bit installer]** - [*signature*](https://qtox-win.pkg.tox.chat/qtox/win32/setup-qtox.exe.asc)
- [**64 bit portable**](https://build.tox.chat/job/qTox_build_windows_x86-64_release/lastSuccessfulBuild/artifact/qTox_build_windows_x86-64_release.zip)
- [**32 bit portable**](https://build.tox.chat/job/qTox_build_windows_x86_release/lastSuccessfulBuild/artifact/qTox_build_windows_x86_release.zip)
* **Linux**:
- [**CentOS, Debian, Fedora, openSUSE, Ubuntu**](https://software.opensuse.org/download.html?project=home%3Aantonbatenev%3Atox&package=qtox)
- [other](/INSTALL.md#linux)
* **Mac**:
- **[Building instructions]**
- [**Experimental download**](https://github.com/qTox/qTox/releases/latest)
* **FreeBSD**:
- [**Port**](/INSTALL.md#freebsd-easy)
<br/>
Builds other than installer/packages don't receive updates automatically, so
make sure you get back to this site and regularly download the latest version of
qTox.
### Help us
If you're wondering how could you help, fear not, there are plenty of ways
:smile:
Some of them are:
* Spread the good word about qTox to make it more popular :smile:
* Have an opinion? Make sure to [voice it in the issues that need it] :wink:
* Fixing [easy issues]
* [Testing] and [reporting bugs]
* [Translating, it's easy]
* [Reviewing and testing pull requests] you don't need to be able to code to
do that :wink:
* [Coding]
If you want to contribute code, you probably will be interested in [issues that
need help].
#### Screenshots
Note: The screenshots may not always be up to date, but they should give a good
idea of the general look and features.
![Screenshot 01](https://i.imgur.com/olb89CN.png)
![Screenshot 02](https://i.imgur.com/tmX8z9s.png)
#### Features
- One to one chat with friends
- Group chats
- File transfers, with previewing of images
- Audio calls, including group calls
- Video calls
- ToxMe and Tox URI support
- Translations in 30 languages [](← TODO: add `over` when there'll be more)
- Avatars
- Faux offline messages
- History
- Screenshots
- Emoticons
- Auto-updates on Windows and packages on Linux
- And many more options!
#### Organizational stuff
**[Roadmap]**
Happens in both IRC channel [#qtox@freenode] and on [qTox-dev mailing list].
If you are interested in participating, **join the channel** and **subscribe to
the mailing list**.
There are [IRC logs] available.
[![Build Status](https://travis-ci.org/qTox/qTox.svg?branch=master)](https://travis-ci.org/qTox/qTox)
[#qtox@freenode]: https://webchat.freenode.net/?channels=qtox
[64 bit installer]: https://build.tox.chat/view/qtox/job/qTox_pkg_windows_x86-64_stable_release/lastSuccessfulBuild/artifact/setup-qtox.exe
[32 bit installer]: https://build.tox.chat/view/qtox/job/qTox_pkg_windows_x86_stable_release/lastSuccessfulBuild/artifact/setup-qtox.exe
[Building instructions]: /INSTALL.md#os-x
[Coding]: https://github.com/qTox/qTox/blob/master/CONTRIBUTING.md#how-to-start-contributing
[easy issues]: https://github.com/qTox/qTox/labels/E-easy
[IRC logs]: https://github.com/qTox/qtox-irc-logs
[issues that need help]: https://github.com/qTox/qTox/labels/help%20wanted
[qTox-dev mailing list]: https://lists.tox.chat/listinfo/qtox-dev
[reporting bugs]: https://github.com/qTox/qTox/wiki/Writing-Useful-Bug-Reports
[Reviewing and testing pull requests]: /CONTRIBUTING.md#reviews
[Roadmap]: https://github.com/qTox/qTox/milestones
[Testing]: https://github.com/qTox/qTox/wiki/Testing
[Translating, it's easy]: https://github.com/qTox/qTox/blob/master/translations/README.md
[voice it in the issues that need it]: https://github.com/qTox/qTox/labels/I-feedback-wanted