mirror of
https://github.com/Tha14/toxic.git
synced 2024-11-14 17:23:03 +01:00
Polishing README.md
- Corrected English phrasing throughout - Display screenshot on the page instead of a link - Clarification as to what 'libtoxav' is - Numeration for compilation steps instead of an unsorted list - Separated compilation instructions into steps and notes - Added links for dependencies
This commit is contained in:
parent
f75248d177
commit
9b69cecfb1
41
README.md
41
README.md
@ -1,35 +1,40 @@
|
|||||||
# Toxic [![Build Status](https://travis-ci.org/Tox/toxic.png?branch=master)](https://travis-ci.org/Tox/toxic)
|
# Toxic
|
||||||
Toxic is an ncurses based instant messaging client for [Tox](https://tox.im) which formerly resided in the [Tox core repository](https://github.com/irungentoo/toxcore) and is now available as a standalone program. It looks like [this](http://i.imgur.com/hL7WhVl.png).
|
Toxic is an ncurses-based instant messaging client for [Tox](https://tox.im) which formerly resided in the [Tox core repository](https://github.com/irungentoo/toxcore), and is now available as a standalone application.
|
||||||
|
|
||||||
|
![Toxic Screenshot](http://i.imgur.com/hL7WhVl.png "Main Screen").
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
### Base dependencies
|
### Dependencies
|
||||||
* libtoxcore
|
##### Base
|
||||||
* ncurses (for Debian based systems: libncurses5-dev libncursesw5-dev)
|
* [libtoxcore](https://github.com/irungentoo/toxcore)
|
||||||
|
* [ncurses](http://www.gnu.org/software/ncurses) (for Debian based systems, 'libncurses5-dev' and 'libncursesw5-dev')
|
||||||
|
|
||||||
### Audio dependencies
|
##### Audio
|
||||||
* libtoxav
|
* libtoxav (libtoxcore compiled with audio support)
|
||||||
* openal
|
* [openal](http://openal.org)
|
||||||
|
|
||||||
### Compiling
|
### Compiling
|
||||||
* `cd build/`
|
1. `cd build/`
|
||||||
* `make`
|
2. `make`
|
||||||
* `sudo make install DESTDIR="/path/you/like"`
|
3. `sudo make install DESTDIR="/where/to/install"`
|
||||||
* You can add specific flags to makefile with `USER_CFLAGS=""` and/or `USER_LDFLAGS=""`
|
|
||||||
* You can pass your own flags to makefile with `CFLAGS=""` and/or `LDFLAGS=""` (this will supersede the defaults one)
|
### Compilation Notes
|
||||||
* Audio calling support is automatically enabled if all dependencies are found
|
* 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)
|
||||||
|
* Audio call support is automatically enabled if all dependencies are found
|
||||||
|
|
||||||
### Troubleshooting
|
### Troubleshooting
|
||||||
If your default prefix is "/usr/local" and you get the error:
|
If your default prefix is "/usr/local" and you receive the following:
|
||||||
```
|
```
|
||||||
error while loading shared libraries: libtoxcore.so.0: cannot open shared object file: No such file or directory
|
error while loading shared libraries: libtoxcore.so.0: cannot open shared object file: No such file or directory
|
||||||
```
|
```
|
||||||
you can try fix it running `sudo ldconfig`.
|
you can attempt to correct it by running `sudo ldconfig`. If that doesn't work, run:
|
||||||
If that doesn't fix it, run:
|
|
||||||
```
|
```
|
||||||
echo '/usr/local/lib/' | sudo tee -a /etc/ld.so.conf.d/locallib.conf
|
echo '/usr/local/lib/' | sudo tee -a /etc/ld.so.conf.d/locallib.conf
|
||||||
sudo ldconfig
|
sudo ldconfig
|
||||||
```
|
```
|
||||||
|
|
||||||
## Settings
|
## Settings
|
||||||
After running Toxic for the first time an empty file called toxic.conf should reside in your home configuration directory ("~/.config/tox" for Linux users). For an example on how to use this config file to save settings such as auto-logging and time format see: [misc/toxic.conf](misc/toxic.conf).
|
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.
|
||||||
|
You can view our example config file [here](misc/toxic.conf).
|
||||||
|
Loading…
Reference in New Issue
Block a user