From 3ea7fc0f0ac6184b82db71c8a16db291ef45c247 Mon Sep 17 00:00:00 2001 From: Bill Winslow Date: Mon, 1 Sep 2014 15:47:40 -0500 Subject: [PATCH 1/2] Updated README.md, fix 239 --- README.md | 57 ++++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 46 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 0e4f060b8..81e1f665a 100644 --- a/README.md +++ b/README.md @@ -15,29 +15,64 @@ However, it is not a fork. - Tox DNS - Translations in various languages -

Requirements

+

Downloads

-This client runs on Windows, Linux and Mac natively, but is not build regularly for Linux
-Linux users will have to compile the source code themselves if they want the latest updates. +This client runs on Windows, Linux and Mac natively.
Windows download
Mac download
-Linux download (12st July 2014 20:30 GMT)
-Note that the Linux download has not been tested and may not be up to date.
+Linux download (click "Last successful artifacts")

Screenshots

Note: The screenshots may not always be up to date, but they should give a good idea of the general look and features
-

Compiling

-Compiling toxgui requires Qt 5.2 with the Qt Multimedia module and a C++11 compatible compiler. -It also requires the toxcore and toxav libraries. +

Compiling on GNU-Linux

+

Acquiring dependencies

+Compiling qTox requires several dependencies, however these are easily installable +with your system's package manager. The step-by-step instructions assume Debian-style apt, but +it should be easy enough to get the packes with yum or pacman. -To compile, first clone or download the qTox repository and open a terminal in the qTox folder. -Then run the script bootstrap.sh (for Linux and Mac) or bootsrap.bat (for Windows) to download an up-to-date toxcore. -And finally run the commands "qmake" and "make" to start building qTox. +First, we need Qt 5.2 with a C++11 compatible compiler: +```bash +sudo apt-get install build-essential qt5-qmake qt5-default +``` +toxcore and toxav, the client-agnostic network code for Tox, has several dependencies +of its own (see its installation guide for more details): +```bash +sudo apt-get install libtool autotools-dev automake checkinstall check git yasm libopus-dev libvpx-dev +``` + +Finally, qTox itself requires OpenAL and OpenCV: +```bash +sudo apt-get install libopenal-dev libopencv-dev +``` + +

Compilation

+ +Having acquired all the dependencies, the following commands should get and compile qTox: + +```bash +wget -O qtox.tgz https://github.com/tux3/qTox/archive/master.tar.gz +tar xvf qtox.tgz +cd qTox-master +./bootstrap.sh # This will automagically download and compile libsodium, toxcore, and toxav +qmake +make # Should compile to "qtox" +``` + +And that's it! + +

Building packages

+ +qTox now has the experimental and probably-dodgy ability to package itself (in .deb +form natively, and .rpm form with alien). + +After installing the required dependencies, run `bootstrap.sh` and then run the +`buildPackages.sh` script, found in the tools folder. It will automatically get the +necessary packages for building .debs, so be prepared to type your password for sudo.

OSX Easy Install

From 9ea2566ba003c3ca74cc5a1b61f568abb657aad6 Mon Sep 17 00:00:00 2001 From: Bill Winslow Date: Mon, 1 Sep 2014 15:52:51 -0500 Subject: [PATCH 2/2] minutiae --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 81e1f665a..6264fbf25 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ This client runs on Windows, Linux and Mac natively.

Acquiring dependencies

Compiling qTox requires several dependencies, however these are easily installable with your system's package manager. The step-by-step instructions assume Debian-style apt, but -it should be easy enough to get the packes with yum or pacman. +it should be easy enough to get equivalent packages with yum or pacman. First, we need Qt 5.2 with a C++11 compatible compiler: ```bash @@ -40,7 +40,7 @@ sudo apt-get install build-essential qt5-qmake qt5-default ``` toxcore and toxav, the client-agnostic network code for Tox, has several dependencies -of its own (see its installation guide for more details): +of its own (see its installation guide for more details): ```bash sudo apt-get install libtool autotools-dev automake checkinstall check git yasm libopus-dev libvpx-dev ``` @@ -72,7 +72,7 @@ form natively, and .rpm form with alien< After installing the required dependencies, run `bootstrap.sh` and then run the `buildPackages.sh` script, found in the tools folder. It will automatically get the -necessary packages for building .debs, so be prepared to type your password for sudo. +packages necessary for building .debs, so be prepared to type your password for sudo.

OSX Easy Install