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

Update README: toxgui -> qTox

Browse Source
This commit is contained in:
Tux3 / Mlkj / !Lev.uXFMLA 2014-07-12 20:30:07 +02:00
parent 40d6ea363d
commit ef3c64af1f
1 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -1,8 +1,8 @@
toxgui
qTox
======
For-fun Tox client that tries to follow the Tox UI mockup while running on all major systems. <br/>
This GUI uses code from @nurupo's ProjectTox-Qt-GUI, in particular the "Core" Toxcore wrapper. <br/>
Powerful Tox client that tries to follow the Tox UI mockup while running on all major systems. <br/>
This GUI uses code from @nurupo'tos ProjectTox-Qt-GUI, in particular the "Core" Toxcore wrapper. <br/>
However, it is not a fork.
<h2>Features</h2>
@ -17,8 +17,8 @@ However, it is not a fork.
<h2>Requirements</h2>
This client will run on Windows, Linux and Mac natively, but binaries are only regularly built for windows <br/>
Linux and Mac users will have to compile the source code themselves if they want the latest updates.
This client runs on Windows, Linux and Mac natively, but is not build regularly for Linux <br/>
Linux users will have to compile the source code themselves if they want the latest updates.
<a href="https://jenkins.libtoxcore.so/job/tux3-toxgui-win32/lastSuccessfulBuild/artifact/toxgui-win32.zip">Windows download</a><br/>
<a href="https://jenkins.libtoxcore.so/job/ToxGUI%20OS%20X/lastSuccessfulBuild/artifact/toxgui.dmg">Mac download </a><br/>
@ -34,14 +34,14 @@ Note that the Linux download has not been tested and may not be up to date.<br/>
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.
To compile, first clone or download the toxgui repository and open a terminal in the toxgui folder.
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 toxgui.
And finally run the commands "qmake" and "make" to start building qTox.
<h3>OSX Install Guide</h3>
<strong>This guide is intended for people who wish to use an existing or new ProjectTox-Core installation separate to the bundled installation with toxgui, if you do not wish to use a separate installation you can skip to the section titled 'Final Steps'.</strong>
<strong>This guide is intended for people who wish to use an existing or new ProjectTox-Core installation separate to the bundled installation with qTox, if you do not wish to use a separate installation you can skip to the section titled 'Final Steps'.</strong>
Installation on OSX, isn't quite straight forward, here is a quick guide on how to install;
@ -63,16 +63,16 @@ This is not a permanent change, it will revert when you close the terminal windo
Once this is installed, do the following;
```bash
git clone https://github.com/tux3/toxgui
git clone https://github.com/tux3/qTox
cd toxgui
qmake
```
Now, we need to create a symlink to /usr/local/lib/ and /usr/local/include/
```
mkdir -p $HOME/toxgui/libs
sudo ln -s /usr/local/lib $HOME/toxgui/libs/lib
sudo ln -s /usr/local/include $HOME/toxgui/libs/include
mkdir -p $HOME/qTox/libs
sudo ln -s /usr/local/lib $HOME/qTox/libs/lib
sudo ln -s /usr/local/include $HOME/qTox/libs/include
```
<h5>Final Steps</h5>
@ -80,8 +80,8 @@ The final step is to run
```bash
make
```
in the toxgui directory, or if you are using the bundled tox core installation, you can use
in the qTox directory, or if you are using the bundled tox core installation, you can use
```bash
./bootstrap.sh
```
Assuming all went well you should now have a toxgui.app file within the directory. Double click and it should open!
Assuming all went well you should now have a qTox.app file within the directory. Double click and it should open!