1
0
mirror of https://github.com/Tha14/toxic.git synced 2024-11-23 12:13:02 +01:00
toxic/README.md

69 lines
3.5 KiB
Markdown
Raw Permalink Normal View History

# Toxic [![Build Status](https://travis-ci.org/Tox/toxic.png?branch=master)](https://travis-ci.org/Tox/toxic)
2014-07-04 20:25:22 +02:00
Toxic is a [Tox](https://tox.im)-based instant messenging client which formerly resided in the [Tox core repository](https://github.com/irungentoo/toxcore), and is now available as a standalone application.
2014-08-26 10:39:43 +02:00
![Toxic Screenshot](https://i.imgur.com/ryaEmQZ.png "Home Screen")
2013-08-23 10:57:16 +02:00
2014-03-04 09:08:04 +01:00
## Installation
2013-08-23 10:57:16 +02:00
### Dependencies
##### Base
* [libtoxcore](https://github.com/irungentoo/toxcore)
2014-06-24 17:46:52 +02:00
* [ncurses](https://www.gnu.org/software/ncurses) (for Debian based systems, 'libncursesw5-dev')
* [libconfig](http://www.hyperrealm.com/libconfig) (for Debian based systems, 'libconfig-dev')
2013-08-23 10:57:16 +02:00
##### Audio
* libtoxav ([libtoxcore](https://github.com/irungentoo/toxcore) compiled with audio support)
* [openal](http://openal.org) (for Debian based systems, 'libopenal-dev')
##### Sound notifications
* [openal](http://openal.org) (for Debian based systems, 'libopenal-dev')
* [openalut](http://openal.org) (for Debian based systems, 'libalut-dev')
##### Desktop notifications
* [libnotify](https://developer.gnome.org/libnotify) (for Debian based systems, 'libnotify-dev')
##### Documentation
2014-08-25 12:54:44 +02:00
* [Asciidoc](http://asciidoc.org/index.html) (only required for regenerating manpages)
2014-08-25 12:59:34 +02:00
* Run `make doc` after editing the asciidoc files to regenerate the manpages.
* **NOTE FOR DEVELOPERS**: asciidoc files and generated manpages will need to be commited together.
2014-06-24 12:28:56 +02:00
### Compiling
1. `cd build/`
2014-06-25 09:13:57 +02:00
2. `make PREFIX="/where/to/install"`
3. `sudo make install PREFIX="/where/to/install"`
### Compilation Notes
* You can add specific flags to the Makefile with `USER_CFLAGS=""` and/or `USER_LDFLAGS=""`
* You can pass your own flags to the Makefile with `CFLAGS=""` and/or `LDFLAGS=""` (this will supersede the default ones)
* Additional features are automatically enabled if all dependencies are found, but you can disable them by using special variables:
* `DISABLE_AV=1` → build toxic without audio call support
* `DISABLE_SOUND_NOTIFY=1` → build toxic without sound notifications support
* `DISABLE_DESKTOP_NOTIFY=1` → build toxic without desktop notifications support
2014-06-24 12:28:56 +02:00
2014-06-25 09:13:57 +02:00
### Packaging
2014-06-25 10:54:05 +02:00
* For packaging purpose, you can use `DESTDIR=""` to specify a directory where to store installed files
2014-06-25 09:13:57 +02:00
* `DESTDIR=""` can be used in addition to `PREFIX=""`:
2014-06-25 10:54:05 +02:00
* `DESTDIR=""` is meant to specify a directory where to store installed files (ex: "/tmp/build/pkg")
2014-06-25 09:13:57 +02:00
* `PREFIX=""` is meant to specify a prefix directory for binaries and data files (ex: "/usr/local")
2014-06-24 12:28:56 +02:00
### Troubleshooting
If your default prefix is "/usr/local" and you receive the following:
2014-06-24 12:45:14 +02:00
```
error while loading shared libraries: libtoxcore.so.0: cannot open shared object file: No such file or directory
```
you can attempt to correct it by running `sudo ldconfig`. If that doesn't work, run:
```
echo '/usr/local/lib/' | sudo tee -a /etc/ld.so.conf.d/locallib.conf
sudo ldconfig
```
2014-06-24 12:28:56 +02:00
2014-07-24 13:05:56 +02:00
## Precompiled binaries
You can download precompiled binaries from [jenkins](https://jenkins.libtoxcore.so):
* [Linux 32 bit](https://jenkins.libtoxcore.so/job/toxic_linux_i386/lastSuccessfulBuild/artifact/toxic_linux_i386.tar.xz)
* [Linux 64 bit](https://jenkins.libtoxcore.so/job/toxic_linux_amd64/lastSuccessfulBuild/artifact/toxic_linux_amd64.tar.xz)
2014-04-08 08:17:19 +02:00
## Settings
Running Toxic for the first time creates an empty file called toxic.conf in your home configuration directory ("~/.config/tox" for Linux users). Adding options to this file allows you to enable auto-logging, change the time format (12/24 hour), and much more.
2014-06-28 18:04:10 +02:00
You can view our example config file [here](misc/toxic.conf.example).