StarMirror/qTox
1
0
Fork 0
mirror of https://github.com/qTox/qTox.git synced 2024-03-22 14:00:36 +08:00
Code Issues Projects Releases Wiki Activity
560751db88
qTox/README.md

197 lines
7.1 KiB
Markdown
Raw Normal View History

fix(README): Fix mardown to correct display on github
2017-03-21 14:10:10 +08:00
<a name="qtox" />
docs(README): refactor/improve README.md add logo * move links to the "footer" * "group" install options in a table, bold the recommended * move & add badges
2016-10-26 16:47:35 +08:00
<p align="center">
<img src="https://qtox.github.io/assets/imgs/logo_head.png" alt="qTox" />
</p>
fix(README): Fix mardown to correct display on github
2017-03-21 14:10:10 +08:00
docs(README): refactor/improve README.md add logo * move links to the "footer" * "group" install options in a table, bold the recommended * move & add badges
2016-10-26 16:47:35 +08:00
---
fix(README): Fix mardown to correct display on github
2017-03-21 14:10:10 +08:00
docs(README): refactor/improve README.md add logo * move links to the "footer" * "group" install options in a table, bold the recommended * move & add badges
2016-10-26 16:47:35 +08:00
<p align="center">
<a href="https://github.com/qTox/qTox/blob/master/LICENSE">
<img src="https://img.shields.io/badge/license-GPLv3%2B-blue.svg" alt="GPLv3+" />
</a>
<a href="https://travis-ci.org/qTox/qTox">
<img src="https://travis-ci.org/qTox/qTox.svg?branch=master" alt="Travis CI" />
</a>
<a href="https://hosted.weblate.org/engage/tox/?utm_source=widget">
<img src="https://hosted.weblate.org/widgets/tox/-/svg-badge.svg"
alt="Translate on Weblate" />
chore(README): add week status badge It informs whether given week is a week of merges, or week of testing before the release.
2016-10-30 01:33:21 +08:00
</a>
chore(README): add gitter badge to README.md
2017-05-07 20:01:36 +08:00
<a href="https://gitter.im/qtox/qTox?utm_source=badge">
<img src="https://badges.gitter.im/Join Chat.svg" alt="Gitter">
</a>
chore(README): add week status badge It informs whether given week is a week of merges, or week of testing before the release.
2016-10-30 01:33:21 +08:00
<a href="https://github.com/qTox/release-schedule/blob/master/README.md">
<img src="https://qtox.github.io/release-schedule/status.svg"
title="Week of Merges: population of Merges increases!
Week of Testing: Your mana regenerates!" />
docs(README): refactor/improve README.md add logo * move links to the "footer" * "group" install options in a table, bold the recommended * move & add badges
2016-10-26 16:47:35 +08:00
</a></p>
fix(README): Fix mardown to correct display on github
2017-03-21 14:10:10 +08:00
docs(README): refactor/improve README.md add logo * move links to the "footer" * "group" install options in a table, bold the recommended * move & add badges
2016-10-26 16:47:35 +08:00
---
fix(README): Fix mardown to correct display on github
2017-03-21 14:10:10 +08:00
docs(README): refactor/improve README.md add logo * move links to the "footer" * "group" install options in a table, bold the recommended * move & add badges
2016-10-26 16:47:35 +08:00
<p align="center"><b>
docs(README): update description to match repository description
2018-09-30 20:16:04 +08:00
qTox is a chat, voice, video, and file transfer instant messaging client using
the encrypted peer-to-peer Tox protocol.
docs(README): refactor/improve README.md add logo * move links to the "footer" * "group" install options in a table, bold the recommended * move & add badges
2016-10-26 16:47:35 +08:00
</b></p>
**[User Manual] |**
**[Install/Build] |**
**[Roadmap] |**
**[Report bugs] |**
**[Jenkins builds] |**
**[Mailing list] |**
docs(CONTRIBUTING): Update IRC info
2021-09-18 08:58:02 +08:00
**IRC:** [#qtox@libera.chat]
docs(README): refactor/improve README.md add logo * move links to the "footer" * "group" install options in a table, bold the recommended * move & add badges
2016-10-26 16:47:35 +08:00
fix(README): Fix mardown to correct display on github
2017-03-21 14:10:10 +08:00
---
docs(README): refactor/improve README.md add logo * move links to the "footer" * "group" install options in a table, bold the recommended * move & add badges
2016-10-26 16:47:35 +08:00
Windows | Linux | OS X | FreeBSD
--------|-------|------|--------
fix(docs): remove extra comma in README.md
2019-07-31 16:10:19 +08:00
**[64 bit release]**| **[Arch]**, **[Debian]**, **[Fedora]**, **[Gentoo]**, **[openSUSE]**, **[Ubuntu]** | **[Latest release]** | **[Package & Port]**
chore: update README.md
2018-07-11 01:44:35 +08:00
[32 bit release]|**[AppImage]**, [Flatpak] | [Building instructions] |
chore: replace dead links in README.md
2019-10-09 04:21:24 +08:00
[64 bit][64nightly], [32 bit][32nightly] nightly | [From Source], [Flatpak nightly], [AppImage nightly] | [Latest nightly] |
docs(README): refactor/improve README.md add logo * move links to the "footer" * "group" install options in a table, bold the recommended * move & add badges
2016-10-26 16:47:35 +08:00
_**Bold** options are recommended._
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:
docs(README): refactor/improve README.md add logo * move links to the "footer" * "group" install options in a table, bold the recommended * move & add badges
2016-10-26 16:47:35 +08:00
* Fixing [easy issues] or [issues that need help]. Make sure to read
[Contributing] first though :wink:
docs(README): list some of the ways to help qTox
2016-10-05 21:34:05 +08:00
* [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:
chore(README): add roadmap
2018-07-13 17:05:33 +08:00
* Take a task from our Roadmap below
### Roadmap
Currently qTox is under a feature freeze to clean up our codebase and tools.
During this time we want to prepare qTox for upcoming new features of toxcore.
The next steps are:
* move all toxcore abstractions into their own subproject
* write basic tests for this Core
* format the code base
* rework our TravisCI setup for faster PR checks
* rethink our Issue tracker
The current state is tracked in the [Code cleanup] project.
docs(README): list some of the ways to help qTox
2016-10-05 21:34:05 +08:00
docs(README): refactor/improve README.md add logo * move links to the "footer" * "group" install options in a table, bold the recommended * move & add badges
2016-10-26 16:47:35 +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
docs(README): refactor/improve README.md add logo * move links to the "footer" * "group" install options in a table, bold the recommended * move & add badges
2016-10-26 16:47:35 +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
docs(README): refactor/improve README.md add logo * move links to the "footer" * "group" install options in a table, bold the recommended * move & add badges
2016-10-26 16:47:35 +08:00
- Translations in over 30 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
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): refactor/improve README.md add logo * move links to the "footer" * "group" install options in a table, bold the recommended * move & add badges
2016-10-26 16:47:35 +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(CONTRIBUTING): Update IRC info
2021-09-18 08:58:02 +08:00
Happens in both IRC channel [#qtox@libera.chat] and on [qTox-dev mailing list].
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
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
docs(README): list GPG fingerprints of qTox maintainers & packagers Re: #4045 #3912
2017-01-04 22:04:46 +08:00
### GPG fingerprints
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): list GPG fingerprints of qTox maintainers & packagers Re: #4045 #3912
2017-01-04 22:04:46 +08:00
List of GPG fingerprints used by qTox developers to sign commits, merges, tags,
and possibly other stuff.
Active qTox maintainers:
```
fix(docs): include master key fingerprint instead of subkey fingerprint Fix #5048
2018-04-04 02:41:28 +08:00
7EB3 39FE 8817 47E7 01B7 D472 EBE3 6E66 A842 9B99 - Anthony Bilinski
docs(README): list GPG fingerprints of qTox maintainers & packagers Re: #4045 #3912
2017-01-04 22:04:46 +08:00
3103 9166 FA90 2CA5 0D05 D608 5AF9 F2E2 9107 C727 – Diadlo
docs: added fingerprint
2017-08-08 21:49:43 +08:00
CA92 21C5 389B 7C50 AA5F 7793 52A5 0775 BE13 DF17 - noavarice
docs(README): list GPG fingerprints of qTox maintainers & packagers Re: #4045 #3912
2017-01-04 22:04:46 +08:00
DA26 2CC9 3C0E 1E52 5AD2 1C85 9677 5D45 4B8E BF44 – sudden6
docs(readme): add GPG fingerprint of tox-user Add GPG fingerprint of tox-user as maintainer.
2018-03-13 05:48:40 +08:00
141C 880E 8BA2 5B19 8D0F 850F 7C13 2143 C1A3 A7D4 – tox-user
docs(README): list GPG fingerprints of qTox maintainers & packagers Re: #4045 #3912
2017-01-04 22:04:46 +08:00
2880 C860 D95C 909D 3DA4 5C68 7E08 6DD6 6126 3264 – tux3
```
Past qTox maintainers:
```
chore: update README.md
2018-07-11 01:44:35 +08:00
C7A2 552D 0B25 0F98 3827 742C 1332 03A3 AC39 9151 – initramfs
BA78 83E2 2F9D 3594 5BA3 3760 5313 7C30 33F0 9008 – zetok
docs(README): list GPG fingerprints of qTox maintainers & packagers Re: #4045 #3912
2017-01-04 22:04:46 +08:00
F365 8D0A 04A5 76A4 1072 FC0D 296F 0B76 4741 106C – agilob
docs: remove no longer updated repositories with outdated builds Also mark antis81 as past maintainer.
2017-05-02 20:27:03 +08:00
1157 616B BD86 0C53 9926 F813 9591 A163 FF9B E04C – antis81
docs(README): list GPG fingerprints of qTox maintainers & packagers Re: #4045 #3912
2017-01-04 22:04:46 +08:00
1D29 8BC7 25B7 BE82 65BA EAB9 3DB8 E053 15C2 20AA – Dubslow
```
Windows updates, managed by `tux3`:
```
AED3 1134 9C23 A123 E5C4 AA4B 139C A045 3DA2 D773
```
docs(CONTRIBUTING): Update IRC info
2021-09-18 08:58:02 +08:00
[#qtox@libera.chat]: https://web.libera.chat/#qtox
chore(release): Update version number to v1.17.3
2020-11-22 21:01:29 +08:00
[64 bit release]: https://github.com/qTox/qTox/releases/download/v1.17.3/setup-qtox-x86_64-release.exe
[32 bit release]: https://github.com/qTox/qTox/releases/download/v1.17.3/setup-qtox-i686-release.exe
chore: replace dead links in README.md
2019-10-09 04:21:24 +08:00
[32nightly]: https://github.com/qTox/qTox-nightly-releases/releases/download/ci-master-latest/setup-qtox-i686-release.exe
[64nightly]: https://github.com/qTox/qTox-nightly-releases/releases/download/ci-master-latest/setup-qtox-x86_64-release.exe
chore(release): Update version number to v1.17.3
2020-11-22 21:01:29 +08:00
[Flatpak]: https://github.com/qTox/qTox/releases/download/v1.17.3/qTox-v1.17.3.x86_64.flatpak
chore: replace dead links in README.md
2019-10-09 04:21:24 +08:00
[Flatpak nightly]: https://github.com/qTox/qTox-nightly-releases/releases/download/ci-master-latest/qtox.flatpak
chore(release): Update version number to v1.17.3
2020-11-22 21:01:29 +08:00
[AppImage]: https://github.com/qTox/qTox/releases/download/v1.17.3/qTox-v1.17.3.x86_64.AppImage
chore: replace dead links in README.md
2019-10-09 04:21:24 +08:00
[AppImage nightly]: https://github.com/qTox/qTox-nightly-releases/releases/tag/ci-master-latest
docs(README): refactor/improve README.md add logo * move links to the "footer" * "group" install options in a table, bold the recommended * move & add badges
2016-10-26 16:47:35 +08:00
[Arch]: /INSTALL.md#arch
docs(README): link to instructions for OSX building
2016-10-18 23:05:42 +08:00
[Building instructions]: /INSTALL.md#os-x
docs(README): refactor/improve README.md add logo * move links to the "footer" * "group" install options in a table, bold the recommended * move & add badges
2016-10-26 16:47:35 +08:00
[Contributing]: /CONTRIBUTING.md#how-to-start-contributing
chore(README.md): add Debian and Ubuntu repositories
2018-11-22 01:40:55 +08:00
[Debian]: https://packages.debian.org/search?keywords=qtox
docs(README): list some of the ways to help qTox
2016-10-05 21:34:05 +08:00
[easy issues]: https://github.com/qTox/qTox/labels/E-easy
chore(release): Update version number to v1.17.3
2020-11-22 21:01:29 +08:00
[Latest release]: https://github.com/qTox/qTox/releases/download/v1.17.3/qTox.dmg
chore: replace dead links in README.md
2019-10-09 04:21:24 +08:00
[Latest nightly]: https://github.com/qTox/qTox-nightly-releases/releases/download/ci-master-latest/qTox.dmg
docs(build): Add Fedora to the list of quick install
2018-03-20 21:37:39 +08:00
[Fedora]: /INSTALL.md#fedora
docs(README): refactor/improve README.md add logo * move links to the "footer" * "group" install options in a table, bold the recommended * move & add badges
2016-10-26 16:47:35 +08:00
[Gentoo]: /INSTALL.md#gentoo
chore: update README.md
2018-07-11 01:44:35 +08:00
[openSUSE]: /INSTALL.md#opensuse
docs(README): refactor/improve README.md add logo * move links to the "footer" * "group" install options in a table, bold the recommended * move & add badges
2016-10-26 16:47:35 +08:00
[Install/Build]: /INSTALL.md
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): refactor/improve README.md add logo * move links to the "footer" * "group" install options in a table, bold the recommended * move & add badges
2016-10-26 16:47:35 +08:00
[Jenkins builds]: https://build.tox.chat/
[Mailing list]: https://lists.tox.chat
chore: update README.md
2018-07-11 01:44:35 +08:00
[From Source]: /INSTALL.md#linux
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: Improved the FreeBSD installation instructions. Recommending in this order: 1. The binary package 2. The port
2017-06-22 13:59:04 +08:00
[Package & Port]: /INSTALL.md#freebsd-easy
docs(README): refactor/improve README.md add logo * move links to the "footer" * "group" install options in a table, bold the recommended * move & add badges
2016-10-26 16:47:35 +08:00
[Report bugs]: https://github.com/qTox/qTox/wiki/Writing-Useful-Bug-Reports
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
docs(README): refactor/improve README.md add logo * move links to the "footer" * "group" install options in a table, bold the recommended * move & add badges
2016-10-26 16:47:35 +08:00
[Translating, it's easy]: /translations/README.md
[User Manual]: /doc/user_manual_en.md
chore(README.md): add Debian and Ubuntu repositories
2018-11-22 01:40:55 +08:00
[Ubuntu]: https://packages.ubuntu.com/search?keywords=qtox
docs(README): list some of the ways to help qTox
2016-10-05 21:34:05 +08:00
[voice it in the issues that need it]: https://github.com/qTox/qTox/labels/I-feedback-wanted
chore(README): add roadmap
2018-07-13 17:05:33 +08:00
[Code cleanup]: https://github.com/qTox/qTox/projects/3?fullscreen=true
Reference in New Issue Copy Permalink