qTox/README.md

qTox
======

 [**User Manual**](/doc/user_manual_en.md) **|**
 [**Install**](/INSTALL.md) **|**
 [**Contribute**](https://github.com/tux3/qTox/wiki#contributing) **|**
 [**Report bugs**](https://github.com/tux3/qTox/wiki/Writing-Useful-Bug-Reports) **|**
 [**Translate**](https://github.com/tux3/qTox/wiki/Translating) **|**
 [**Jenkins builds**](https://build.tox.chat/) **|**
 [**Keyboard shortcuts**](https://github.com/tux3/qTox/wiki/Keyboard-shortcuts) **|**
 [**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**](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)
  - [**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**:
  - [**64 bit download**](https://build.tox.chat/view/Clients/job/qTox_build_linux_x86-64_release/lastSuccessfulBuild/artifact/qTox_build_linux_x86-64_release.tar.xz)
  - [**32 bit download**](https://build.tox.chat/view/Clients/job/qTox_build_linux_x86_release/lastSuccessfulBuild/artifact/qTox_build_linux_x86_release.tar.xz)
  - [**Armhf download**](https://build.tox.chat/job/qTox-qt5.4.2_build_linux_armhf_release/lastSuccessfulBuild/artifact/qTox-qt5.4.2_build_linux_armhf_release.tar.xz)
  - [**packages**](/INSTALL.md#simple-install)
* **Mac**:
  - [**Experimental download**](https://github.com/RowenStipe/qTox-OSX/releases)
* **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.


#### 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
- Tox DNS and Tox URI support
- Translations in various languages
- Avatars
- Faux offline messages
- History
- Screenshots
- Emoticons
- Auto-updates on Windows and Mac, packages on Linux
- And many more options!


#### Meetings

Time & place where qTox committee gathers to discuss. Meetings happen every
week on Saturday, `18:00 UTC±00:00` on IRC channel [#qtox@freenode].

Logs from the meetings will be posted at least to the mailing list.

Committee members are active maintainers.

Currently they are:

* @agilob
* @antis81
* @sudden6
* @TheSpiritXIII
* @tux3
* @zetok

[![Build Status](https://travis-ci.org/tux3/qTox.svg)](https://travis-ci.org/tux3/qTox)


[#qtox@freenode]: https://webchat.freenode.net/?channels=qtox
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) \|`
			`[Contribute](https://github.com/tux3/qTox/wiki#contributing) \|`
			`[Report bugs](https://github.com/tux3/qTox/wiki/Writing-Useful-Bug-Reports) \|`
			`[Translate](https://github.com/tux3/qTox/wiki/Translating) \|`
			`[Jenkins builds](https://build.tox.chat/) \|`
			`[Keyboard shortcuts](https://github.com/tux3/qTox/wiki/Keyboard-shortcuts) \|`
			`[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:`
README.md: expose portable builds for windows closes #2766 2016-01-07 21:36:29 +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)`
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:`
README.md: add links to binaries for Linux and Windows 2015-08-21 13:30:12 +08:00			`- [64 bit download](https://build.tox.chat/view/Clients/job/qTox_build_linux_x86-64_release/lastSuccessfulBuild/artifact/qTox_build_linux_x86-64_release.tar.xz)`
			`- [32 bit download](https://build.tox.chat/view/Clients/job/qTox_build_linux_x86_release/lastSuccessfulBuild/artifact/qTox_build_linux_x86_release.tar.xz)`
Add links to qTox ARM builds 2015-09-08 17:25:53 +08:00			`- [Armhf download](https://build.tox.chat/job/qTox-qt5.4.2_build_linux_armhf_release/lastSuccessfulBuild/artifact/qTox-qt5.4.2_build_linux_armhf_release.tar.xz)`
Update install instructions 2015-06-28 02:16:47 +08:00			`- [packages](/INSTALL.md#simple-install)`
Link to experimental OS X downloads Thanks to @RowenStipe ! 2015-10-25 03:45:24 +08:00			`* Mac:`
			`- [Experimental download](https://github.com/RowenStipe/qTox-OSX/releases)`
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

			`#### 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`
Update README.md 2014-11-14 07:30:14 +08:00			`- Tox DNS and Tox URI support`
Update README.md 2014-07-04 21:42:14 +08:00			`- Translations in various languages`
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`
README: Mention package managers on Linux 2014-11-14 07:56:41 +08:00			`- Auto-updates on Windows and Mac, 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
			`#### Meetings`

			`Time & place where qTox committee gathers to discuss. Meetings happen every`
			week on Saturday, `18:00 UTC±00:00` on IRC channel [#qtox@freenode].

			`Logs from the meetings will be posted at least to the mailing list.`

			`Committee members are active maintainers.`

			`Currently they are:`

			`* @agilob`
			`* @antis81`
			`* @sudden6`
			`* @TheSpiritXIII`
			`* @tux3`
			`* @zetok`

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			`[![Build Status](https://travis-ci.org/tux3/qTox.svg)](https://travis-ci.org/tux3/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`