qTox/README.md

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
-												Remove useless travis

											
										
										
											2016-01-04 00:56:32 +08:00
+								qTox
-												Create README.md
											
										
										
											2014-06-25 04:19:37 +08:00
+								======
-												docs(README.md): add info about meetings

Also change unicode `⦁` to `|`, since e.g. on default Debian 8 install
`⦁` is not displayed correctly.

											
										
										
											2016-05-05 05:07:31 +08:00
+								 [**User Manual**](/doc/user_manual_en.md) **|**
 								 [**Install**](/INSTALL.md) **|**
-												docs: move `Reviews` section and add `Testing PRs` section

Since anyone, not just maintainers can review PRs.

											
										
										
											2016-10-07 21:06:22 +08:00
+								 [**Help us**](#help-us) **|**
-												chore: rewrite all links to the qTox repository from tux3 to qTox

											
										
										
											2016-08-04 06:25:50 +08:00
+								 [**Report bugs**](https://github.com/qTox/qTox/wiki/Writing-Useful-Bug-Reports) **|**
-												docs: add docs pointing at easy way to do translations

											
										
										
											2016-05-08 10:30:58 +08:00
+								 [**Translate**](/translations/README.md) **|**
-												docs(README.md): add info about meetings

Also change unicode `⦁` to `|`, since e.g. on default Debian 8 install
`⦁` is not displayed correctly.

											
										
										
											2016-05-05 05:07:31 +08:00
+								 [**Jenkins builds**](https://build.tox.chat/) **|**
 								 [**Mailing list**](https://lists.tox.chat) **|**
 								 **IRC Channel:** [#qtox@freenode]
-												Create README.md
											
										
										
											2014-06-25 04:19:37 +08:00
-												style(Markdown): wrap all .md files at 80 characters

Short lines make it easier to evaluate diffs.
Fix only critical typos, like missing full stops in the middle of a
sentence. Everything else left untouched.

											
										
										
											2016-04-10 05:47:39 +08:00
+								**qTox is a powerful Tox client that follows the Tox design guidelines while
 								running on all major platforms.**
-												Rework README.md

											
										
										
											2015-06-03 04:43:23 +08:00
-												Corrected line in Readme
											
										
										
											2015-08-23 23:19:35 +08:00
+								----
-												Rework README.md

											
										
										
											2015-06-03 04:43:23 +08:00
 								* **Windows**:
-												docs(README): link to instructions for OSX building

											
										
										
											2016-10-18 23:05:42 +08:00
+								  - **[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)
-												revert: docs(README.md): remove obsolete links to portable builds for windows

Revert commit 477ac5b5db00228517f95f11728f5ce8a3ea81fe.

Apparently those links aren't obsolete.

											
										
										
											2016-04-25 00:45:04 +08:00
+								  - [**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)
-												Rework README.md

											
										
										
											2015-06-03 04:43:23 +08:00
+								* **Linux**:
-												docs(README.md): link directly to community repos with packages

											
										
										
											2016-05-20 00:57:01 +08:00
+								  - [**CentOS, Debian, Fedora, openSUSE, Ubuntu**](https://software.opensuse.org/download.html?project=home%3Aantonbatenev%3Atox&package=qtox)
 								  - [other](/INSTALL.md#linux)
-												Link to experimental OS X downloads

Thanks to @RowenStipe !

											
										
										
											2015-10-25 03:45:24 +08:00
+								* **Mac**:
-												docs(README): link to instructions for OSX building

											
										
										
											2016-10-18 23:05:42 +08:00
+								  - **[Building instructions]**
-												chore: rewrite all links to the qTox repository from tux3 to qTox

											
										
										
											2016-08-04 06:25:50 +08:00
+								  - [**Experimental download**](https://github.com/qTox/qTox/releases/latest)
-												Fixes #2554 : updates README.md and INSTALL.md to include FreeBSD port

											
										
										
											2015-12-08 04:30:48 +08:00
+								* **FreeBSD**:
 								  - [**Port**](/INSTALL.md#freebsd-easy)
-												Link to experimental OS X downloads

Thanks to @RowenStipe !

											
										
										
											2015-10-25 03:45:24 +08:00
+								<br/>
-												Rework README.md

											
										
										
											2015-06-03 04:43:23 +08:00
-												style(Markdown): wrap all .md files at 80 characters

Short lines make it easier to evaluate diffs.
Fix only critical typos, like missing full stops in the middle of a
sentence. Everything else left untouched.

											
										
										
											2016-04-10 05:47:39 +08:00
+								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.
-												Update README.md
											
										
										
											2015-08-23 20:24:48 +08:00
-												docs(README): list some of the ways to help qTox

											
										
										
											2016-10-05 21:34:05 +08:00
+								### 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].
-												Update README.md
											
										
										
											2015-08-23 20:24:48 +08:00
 								#### Screenshots
-												style(Markdown): wrap all .md files at 80 characters

Short lines make it easier to evaluate diffs.
Fix only critical typos, like missing full stops in the middle of a
sentence. Everything else left untouched.

											
										
										
											2016-04-10 05:47:39 +08:00
+								Note: The screenshots may not always be up to date, but they should give a good
 								idea of the general look and features.
-												Update README.md
											
										
										
											2015-08-23 20:24:48 +08:00
-												Rework README.md

											
										
										
											2015-06-03 04:43:23 +08:00
-												small border fix
											
										
										
											2016-03-30 04:32:35 +08:00
+								![Screenshot 01](https://i.imgur.com/olb89CN.png)
-												Update README.md
											
										
										
											2015-08-23 20:24:48 +08:00
+								![Screenshot 02](https://i.imgur.com/tmX8z9s.png)
-												Rework README.md

											
										
										
											2015-06-03 04:43:23 +08:00
-												Update README.md
											
										
										
											2015-08-23 20:24:48 +08:00
+								#### Features
-												Create README.md
											
										
										
											2014-06-25 04:19:37 +08:00
-												Add group invite context menu to friends

											
										
										
											2014-06-28 16:53:38 +08:00
+								- One to one chat with friends
 								- Group chats
-												Update README.md
											
										
										
											2014-06-27 01:49:59 +08:00
+								- File transfers, with previewing of images
-												Update README.md

											
										
										
											2014-11-14 07:30:14 +08:00
+								- Audio calls, including group calls
-												Update README.md
											
										
										
											2014-09-13 20:00:37 +08:00
+								- Video calls
-												docs(README.md): update organizational stuff & small update to features

Meetings on IRC didn't work out.

											
										
										
											2016-09-23 12:27:24 +08:00
+								- ToxMe and Tox URI support
 								- Translations in 30 languages [](← TODO: add `over` when there'll be more)
-												Initial avatars support

											
										
										
											2014-09-24 23:28:38 +08:00
+								- Avatars
-												Rework README.md

											
										
										
											2015-06-03 04:43:23 +08:00
+								- Faux offline messages
 								- History
 								- Screenshots
 								- Emoticons
-												docs(README.md): update organizational stuff & small update to features

Meetings on IRC didn't work out.

											
										
										
											2016-09-23 12:27:24 +08:00
+								- Auto-updates on Windows and packages on Linux
-												More consistent README.md

											
										
										
											2015-06-05 03:33:43 +08:00
+								- And many more options!
-												Add travis (again)

Beside making it work again, there are some improvements:

Linux side:

* use minimal supported Qt version, currently it's 5.3
* use minimal supported GCC version, currently 4.8
* use newer ffmpeg version to compile against - 2.8.5
* compile qTox 2 times, first run without support for optional dependencies
* use ubuntu 14.04 for building (less deps needs to be compiled/added from PPAs)

OSX:
* add osx to build targets

											
										
										
											2016-01-26 15:46:35 +08:00
-												docs(README.md): add info about meetings

Also change unicode `⦁` to `|`, since e.g. on default Debian 8 install
`⦁` is not displayed correctly.

											
										
										
											2016-05-05 05:07:31 +08:00
-												docs(README.md): update organizational stuff & small update to features

Meetings on IRC didn't work out.

											
										
										
											2016-09-23 12:27:24 +08:00
+								#### Organizational stuff
-												docs(README.md): add info about meetings

Also change unicode `⦁` to `|`, since e.g. on default Debian 8 install
`⦁` is not displayed correctly.

											
										
										
											2016-05-05 05:07:31 +08:00
-												docs(README.md): update organizational stuff & small update to features

Meetings on IRC didn't work out.

											
										
										
											2016-09-23 12:27:24 +08:00
+								**[Roadmap]**
-												docs(README.md): add info about meetings

Also change unicode `⦁` to `|`, since e.g. on default Debian 8 install
`⦁` is not displayed correctly.

											
										
										
											2016-05-05 05:07:31 +08:00
-												docs(README.md): update organizational stuff & small update to features

Meetings on IRC didn't work out.

											
										
										
											2016-09-23 12:27:24 +08:00
+								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**.
-												docs(README.md): add info about meetings

Also change unicode `⦁` to `|`, since e.g. on default Debian 8 install
`⦁` is not displayed correctly.

											
										
										
											2016-05-05 05:07:31 +08:00
-												docs(README.md): update organizational stuff & small update to features

Meetings on IRC didn't work out.

											
										
										
											2016-09-23 12:27:24 +08:00
+								There are [IRC logs] available.
-												docs(README.md): add info about meetings

Also change unicode `⦁` to `|`, since e.g. on default Debian 8 install
`⦁` is not displayed correctly.

											
										
										
											2016-05-05 05:07:31 +08:00
-												chore: rewrite all links to the qTox repository from tux3 to qTox

											
										
										
											2016-08-04 06:25:50 +08:00
+								[![Build Status](https://travis-ci.org/qTox/qTox.svg?branch=master)](https://travis-ci.org/qTox/qTox)
-												docs(README.md): add info about meetings

Also change unicode `⦁` to `|`, since e.g. on default Debian 8 install
`⦁` is not displayed correctly.

											
										
										
											2016-05-05 05:07:31 +08:00
 								[#qtox@freenode]: https://webchat.freenode.net/?channels=qtox
-												docs(README): link to instructions for OSX building

											
										
										
											2016-10-18 23:05:42 +08:00
+								[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
-												docs(README): list some of the ways to help qTox

											
										
										
											2016-10-05 21:34:05 +08:00
+								[Coding]: https://github.com/qTox/qTox/blob/master/CONTRIBUTING.md#how-to-start-contributing
 								[easy issues]: https://github.com/qTox/qTox/labels/E-easy
-												docs(README.md): update organizational stuff & small update to features

Meetings on IRC didn't work out.

											
										
										
											2016-09-23 12:27:24 +08:00
+								[IRC logs]: https://github.com/qTox/qtox-irc-logs
-												docs(README): list some of the ways to help qTox

											
										
										
											2016-10-05 21:34:05 +08:00
+								[issues that need help]: https://github.com/qTox/qTox/labels/help%20wanted
-												docs(README.md): update organizational stuff & small update to features

Meetings on IRC didn't work out.

											
										
										
											2016-09-23 12:27:24 +08:00
+								[qTox-dev mailing list]: https://lists.tox.chat/listinfo/qtox-dev
-												docs(README): list some of the ways to help qTox

											
										
										
											2016-10-05 21:34:05 +08:00
+								[reporting bugs]: https://github.com/qTox/qTox/wiki/Writing-Useful-Bug-Reports
-												docs: move `Reviews` section and add `Testing PRs` section

Since anyone, not just maintainers can review PRs.

											
										
										
											2016-10-07 21:06:22 +08:00
+								[Reviewing and testing pull requests]: /CONTRIBUTING.md#reviews
-												docs(README.md): update organizational stuff & small update to features

Meetings on IRC didn't work out.

											
										
										
											2016-09-23 12:27:24 +08:00
+								[Roadmap]: https://github.com/qTox/qTox/milestones
-												docs(README): list some of the ways to help qTox

											
										
										
											2016-10-05 21:34:05 +08:00
+								[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