1
0
mirror of https://github.com/qTox/qTox.git synced 2024-03-22 14:00:36 +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
This commit is contained in:
Zetok Zalbavar 2016-10-26 09:47:35 +01:00
parent c8a08530b7
commit e8e946d4c8
No known key found for this signature in database
GPG Key ID: C953D3880212068A

102
README.md
View File

@ -1,34 +1,42 @@
qTox <a name="qtox" \>
====== <p align="center">
<img src="https://qtox.github.io/assets/imgs/logo_head.png" alt="qTox" />
</p>
---
<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" />
</a></p>
---
<p align="center"><b>
qTox is a powerful Tox client that follows the Tox design guidelines
while running on all major platforms.
</b></p>
[**User Manual**](/doc/user_manual_en.md) **|** **[User Manual] |**
[**Install**](/INSTALL.md) **|** **[Install/Build] |**
[**Help us**](#help-us) **|** **[Roadmap] |**
[**Report bugs**](https://github.com/qTox/qTox/wiki/Writing-Useful-Bug-Reports) **|** **[Report bugs] |**
[**Translate**](/translations/README.md) **|** **[Jenkins builds] |**
[**Jenkins builds**](https://build.tox.chat/) **|** **[Mailing list] |**
[**Mailing list**](https://lists.tox.chat) **|** **IRC:** [#qtox@freenode]
**IRC Channel:** [#qtox@freenode]
**qTox is a powerful Tox client that follows the Tox design guidelines while ====
running on all major platforms.**
---- Windows | Linux | OS X | FreeBSD
--------|-------|------|--------
**[64 bit installer]**, [signature][sig-64] | **[CentOS, Debian, Fedora, openSUSE, Ubuntu]** | **[Building instructions]** | **[Port]**
[32 bit installer], [signature][sig-32] | **[Arch]**, **[Gentoo]** | [Experimental download] |
[64 bit][64portable], [32 bit][32portable] portable | [Other] | |
* **Windows**: _**Bold** options are recommended._
- **[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 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 make sure you get back to this site and regularly download the latest version of
@ -43,18 +51,15 @@ Some of them are:
* Spread the good word about qTox to make it more popular :smile: * 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: * Have an opinion? Make sure to [voice it in the issues that need it] :wink:
* Fixing [easy issues] * Fixing [easy issues] or [issues that need help]. Make sure to read
[Contributing] first though :wink:
* [Testing] and [reporting bugs] * [Testing] and [reporting bugs]
* [Translating, it's easy] * [Translating, it's easy]
* [Reviewing and testing pull requests] you don't need to be able to code to * [Reviewing and testing pull requests] you don't need to be able to code to
do that :wink: do that :wink:
* [Coding]
If you want to contribute code, you probably will be interested in [issues that
need help].
#### Screenshots ### Screenshots
Note: The screenshots may not always be up to date, but they should give a good Note: The screenshots may not always be up to date, but they should give a good
idea of the general look and features. idea of the general look and features.
@ -63,7 +68,7 @@ idea of the general look and features.
![Screenshot 02](https://i.imgur.com/tmX8z9s.png) ![Screenshot 02](https://i.imgur.com/tmX8z9s.png)
#### Features ### Features
- One to one chat with friends - One to one chat with friends
- Group chats - Group chats
@ -71,7 +76,7 @@ idea of the general look and features.
- Audio calls, including group calls - Audio calls, including group calls
- Video calls - Video calls
- ToxMe and Tox URI support - ToxMe and Tox URI support
- Translations in 30 languages [](← TODO: add `over` when there'll be more) - Translations in over 30 languages
- Avatars - Avatars
- Faux offline messages - Faux offline messages
- History - History
@ -81,9 +86,7 @@ idea of the general look and features.
- And many more options! - And many more options!
#### Organizational stuff ### Organizational stuff
**[Roadmap]**
Happens in both IRC channel [#qtox@freenode] and on [qTox-dev mailing list]. 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 If you are interested in participating, **join the channel** and **subscribe to
@ -92,21 +95,34 @@ the mailing list**.
There are [IRC logs] available. 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 [#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 [32 bit installer]: https://build.tox.chat/view/qtox/job/qTox_pkg_windows_x86_stable_release/lastSuccessfulBuild/artifact/setup-qtox.exe
[32portable]: https://build.tox.chat/job/qTox_build_windows_x86_release/lastSuccessfulBuild/artifact/qTox_build_windows_x86_release.zip
[64 bit installer]: https://build.tox.chat/view/qtox/job/qTox_pkg_windows_x86-64_stable_release/lastSuccessfulBuild/artifact/setup-qtox.exe
[64portable]: https://build.tox.chat/job/qTox_build_windows_x86-64_release/lastSuccessfulBuild/artifact/qTox_build_windows_x86-64_release.zip
[Arch]: /INSTALL.md#arch
[Building instructions]: /INSTALL.md#os-x [Building instructions]: /INSTALL.md#os-x
[Coding]: https://github.com/qTox/qTox/blob/master/CONTRIBUTING.md#how-to-start-contributing [CentOS, Debian, Fedora, openSUSE, Ubuntu]: https://software.opensuse.org/download.html?project=home%3Aantonbatenev%3Atox&package=qtox
[Contributing]: /CONTRIBUTING.md#how-to-start-contributing
[easy issues]: https://github.com/qTox/qTox/labels/E-easy [easy issues]: https://github.com/qTox/qTox/labels/E-easy
[Experimental download]: https://github.com/qTox/qTox/releases/latest
[Gentoo]: /INSTALL.md#gentoo
[Install/Build]: /INSTALL.md
[IRC logs]: https://github.com/qTox/qtox-irc-logs [IRC logs]: https://github.com/qTox/qtox-irc-logs
[issues that need help]: https://github.com/qTox/qTox/labels/help%20wanted [issues that need help]: https://github.com/qTox/qTox/labels/help%20wanted
[Jenkins builds]: https://build.tox.chat/
[Mailing list]: https://lists.tox.chat
[Other]: /INSTALL.md#linux
[qTox-dev mailing list]: https://lists.tox.chat/listinfo/qtox-dev [qTox-dev mailing list]: https://lists.tox.chat/listinfo/qtox-dev
[Port]: /INSTALL.md#freebsd-easy
[Report bugs]: https://github.com/qTox/qTox/wiki/Writing-Useful-Bug-Reports
[reporting bugs]: https://github.com/qTox/qTox/wiki/Writing-Useful-Bug-Reports [reporting bugs]: https://github.com/qTox/qTox/wiki/Writing-Useful-Bug-Reports
[Reviewing and testing pull requests]: /CONTRIBUTING.md#reviews [Reviewing and testing pull requests]: /CONTRIBUTING.md#reviews
[Roadmap]: https://github.com/qTox/qTox/milestones [Roadmap]: https://github.com/qTox/qTox/milestones
[sig-32]: https://qtox-win.pkg.tox.chat/qtox/win32/setup-qtox.exe.asc
[sig-64]: https://qtox-win.pkg.tox.chat/qtox/win64/setup-qtox.exe.asc
[Testing]: https://github.com/qTox/qTox/wiki/Testing [Testing]: https://github.com/qTox/qTox/wiki/Testing
[Translating, it's easy]: https://github.com/qTox/qTox/blob/master/translations/README.md [Translating, it's easy]: /translations/README.md
[User Manual]: /doc/user_manual_en.md
[voice it in the issues that need it]: https://github.com/qTox/qTox/labels/I-feedback-wanted [voice it in the issues that need it]: https://github.com/qTox/qTox/labels/I-feedback-wanted