diff --git a/docs/install.md b/docs/install.md index 39dbda4..417c464 100644 --- a/docs/install.md +++ b/docs/install.md @@ -1,12 +1,36 @@ -# HOW TO INSTALL TOXYGEN: +# How to install Toxygen -1. [Install Python 2.7 in your system](https://wiki.python.org/moin/BeginnersGuide/Download) +## From source code (recommended for developers) + +### Windows + +1. [Download and install latest Python 2.7](https://www.python.org/downloads/windows/) 2. [Install PySide](https://pypi.python.org/pypi/PySide/1.2.4) *(PyQt4 support will be added later)* -4. [Download toxygen](https://github.com/xveduk/toxygen/archive/master.zip) -5. Unpack archive -6. For Linux users - install [toxcore](https://github.com/irungentoo/toxcore/blob/master/INSTALL.md), for Windows users - download [libtox.dll](https://build.tox.chat/view/libtoxcore/job/libtoxcore_build_windows_x86_shared_release/lastSuccessfulBuild/artifact/libtoxcore_build_windows_x86_shared_release.zip), download [libsodium.a] (https://build.tox.chat/view/libsodium/job/libsodium_build_windows_x86_static_release/lastSuccessfulBuild/artifact/libsodium_build_windows_x86_static_release.zip), put into /src/libs/ -7. Run src/main.py +3. [Download toxygen](https://github.com/xveduk/toxygen/archive/master.zip) +4. Unpack archive +5. Download latest [libtox.dll](https://build.tox.chat/view/libtoxcore/job/libtoxcore_build_windows_x86_shared_release/lastSuccessfulBuild/artifact/libtoxcore_build_windows_x86_shared_release.zip) build, download latest [libsodium.a](https://build.tox.chat/view/libsodium/job/libsodium_build_windows_x86_static_release/lastSuccessfulBuild/artifact/libsodium_build_windows_x86_static_release.zip) build, put it into \src\libs\ +6. Run \src\main.py -# Supported OS: -- Windows -- Linux + +### Linux + +1. [Install PySide](https://wiki.qt.io/PySide_Binaries_Linux) *(PyQt4 support will be added later)* +2. [Download toxygen](https://github.com/xveduk/toxygen/archive/master.zip) +3. Unpack archive +4. Install [toxcore](https://github.com/irungentoo/toxcore/blob/master/INSTALL.md) in your system +5. Run app: +``python src/main.py`` + +## Use precompiled binary: +[Check our releases page](https://github.com/xveduk/toxygen/releases) + +## Compile Toxygen +You can compile Toxygen using [PyInstaller](http://www.pyinstaller.org/): + +On Linux: + +``pyinstaller --windowed src/main.py`` + +On Windows: + +``pyinstaller --windowed --icon images/icon.ico src/main.py`` diff --git a/src/images/icon.ico b/src/images/icon.ico new file mode 100755 index 0000000..c894094 Binary files /dev/null and b/src/images/icon.ico differ