emdee/toxygen
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs update

Browse source
This commit is contained in:
ingvar1995 2016-07-27 17:53:50 +03:00
parent 883a30f806
commit 7d8646b432
4 changed files with 42 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -1,17 +1,22 @@
# Toxygen
# Toxygen
Toxygen is cross-platform [Tox](https://tox.chat/) client written in Python3
[![Release](https://img.shields.io/github/release/xveduk/toxygen.svg?style=flat)](https://github.com/xveduk/toxygen/releases/latest)
[![Open issues](https://img.shields.io/github/issues/xveduk/toxygen.svg?style=flat)](https://github.com/xveduk/toxygen/issues)
[![License](https://img.shields.io/badge/license-GPLv3-blue.svg?style=flat)](https://raw.githubusercontent.com/xveduk/toxygen/master/LICENSE.md)
### [Install](/docs/install.md) - [Contribute](/docs/contributing.md) - [Plugins](/docs/plugins.md)
### [Install](/docs/install.md) - [Contribute](/docs/contributing.md) - [Plugins](/docs/plugins.md) - [Compile](/docs/compile.md) - [Contact](/docs/contact.md)
### Supported OS:
- Windows
- Linux
- OS X
- FreeBSD
### Features
###Features
- [x] 1v1 messages
- [x] File transfers
- [x] Audio
@ -42,19 +47,17 @@ Toxygen is cross-platform [Tox](https://tox.chat/) client written in Python3
- [ ] Desktop sharing
- [ ] Group chats
###Downloads
### Downloads
[Releases](https://github.com/xveduk/toxygen/releases)
[Download last stable version](https://github.com/xveduk/toxygen/archive/master.zip)
[Download develop version](https://github.com/xveduk/toxygen/archive/develop.zip)
###Screenshots
### Screenshots
*Toxygen on Ubuntu and Windows*
![Ubuntu](/docs/ubuntu.png)
![Windows](/docs/windows.png)
###Docs
### Docs
[Check /docs/ for more info](/docs/)

4
docs/compile.md
View file

@ -1,4 +1,4 @@
#Compile Toxygen
# Compile Toxygen
You can compile Toxygen using [PyInstaller](http://www.pyinstaller.org/)
@ -7,4 +7,4 @@ Install PyInstaller:
``pyinstaller --windowed --icon images/icon.ico main.py``
Don't forget to copy /images/, /sounds/, /translations/, /styles/, /smileys/, /stickers/ (and /libs/libtox.dll, /libs/libsodium.a on Windows) to /dist/main/
Don't forget to copy /images/, /sounds/, /translations/, /styles/, /smileys/, /stickers/, /plugins/ (and /libs/libtox.dll, /libs/libsodium.a on Windows) to /dist/main/

4
docs/contact.md Normal file
View file

@ -0,0 +1,4 @@
# Contact us:
1) Using GitHub - open issue
2) Use Toxygen Tox Group - add bot kalina@toxme.io (or 12EDB939AA529641CE53830B518D6EB30241868EE0E5023C46A372363CAEC91C2C948AEFE4EB)

31
docs/install.md
View file

@ -3,7 +3,7 @@
## Use precompiled binary:
[Check our releases page](https://github.com/xveduk/toxygen/releases)
##Using pip3
## Using pip3
### Windows
@ -21,12 +21,21 @@ Run app using ``toxygen`` command.
``sudo pip3.4 install toxygen``
5. Run toxygen using ``toxygen`` command.
### OS X
1. Install [toxcore](https://github.com/irungentoo/toxcore/blob/master/INSTALL.md) with toxav support in your system (install in /usr/lib/)
2. Install PortAudio:
``brew install portaudio``
3. Install toxygen:
``pip3 install toxygen``
4. Run toxygen using ``toxygen`` command.
## From source code (recommended for developers)
### Windows
1. [Download and install latest Python 3.4](https://www.python.org/downloads/windows/)
2. [Install PySide](https://pypi.python.org/pypi/PySide/1.2.4) (recommended) or [PyQt4](https://riverbankcomputing.com/software/pyqt/download)
2. [Install PySide](https://pypi.python.org/pypi/PySide/1.2.4#installing-pyside-on-a-windows-system) (recommended) or [PyQt4](https://riverbankcomputing.com/software/pyqt/download)
3. Install PyAudio: ``pip3.4 install pyaudio``
4. [Download toxygen](https://github.com/xveduk/toxygen/archive/master.zip)
5. Unpack archive
@ -47,7 +56,7 @@ Optional: install toxygen using setup.py: ``python3.4 setup.py install``
1. Install latest Python3:
``sudo apt-get install python3``
2. Install PySide: ``sudo apt-get install python3-pyside`` or install [PyQt4](https://riverbankcomputing.com/software/pyqt/download).
2. Install PySide: ``sudo apt-get install python3-pyside`` or install [PyQt4](https://riverbankcomputing.com/software/pyqt/download) (``sudo apt-get install python3-pyqt4``).
3. Install [toxcore](https://github.com/irungentoo/toxcore/blob/master/INSTALL.md) with toxav support in your system (install in /usr/lib/)
4. Install PyAudio:
``sudo apt-get install portaudio19-dev`` and ``sudo apt-get install python3-pyaudio`` (or ``pip3 install pyaudio``)
@ -56,7 +65,17 @@ Optional: install toxygen using setup.py: ``python3.4 setup.py install``
7. Run app:
``python3.4 main.py``
Optional: install toxygen using setup.py: ``python3 setup.py install``
Optional: install toxygen using setup.py: ``python3.4 setup.py install``
## Compile Toxygen
Check [compile.md](/docs/compile.md) for more info
### OS X
1. [Download and install latest Python 3.4](https://www.python.org/downloads/mac-osx/)
2. [Install PySide](https://pypi.python.org/pypi/PySide/1.2.4#installing-pyside-on-a-mac-os-x-system) (recommended) or [PyQt4](https://riverbankcomputing.com/software/pyqt/download)
3. Install PortAudio:
``brew install portaudio``
4. Install PyAudio: ``pip3 install pyaudio``
4. [Download toxygen](https://github.com/xveduk/toxygen/archive/master.zip)
5. Unpack archive
6. Run \src\main.py.
Optional: install toxygen using setup.py: ``python3 setup.py install``