mirror of
https://github.com/Tha14/toxic.git
synced 2024-11-22 20:03:02 +01:00
Update README.md
This commit is contained in:
parent
3913adedb0
commit
449b6fa5ff
39
README.md
39
README.md
@ -1,25 +1,36 @@
|
||||
# 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](http://tox.im) which formerly resided in the [Tox core repository](https://github.com/irungentoo/ProjectTox-Core) and is now available as a standalone program. It looks like [this](http://i.imgur.com/hL7WhVl.png).
|
||||
## Installation
|
||||
* Generate the configure script by running the ```autoreconf -i``` command.
|
||||
|
||||
* Execute the configure script with ```./configure``` (you may need to pass it the location of your dependency libraries, i.e.):
|
||||
```./configure --prefix=/where/to/install --with-libtoxcore-headers=/path/to/ProjectTox-Core/toxcore --with-libtoxcore-libs=/path/to/ProjectTox-Core/build/.libs --with-libsodium-headers=/path/to/libsodium/include/ --with-libsodium-libs=/path/to/sodiumtest/lib/ ```
|
||||
### Base dependencies
|
||||
* libtoxcore
|
||||
* ncurses (for Debian based systems: libncurses5-dev libncursesw5-dev)
|
||||
|
||||
* Audio calling support requires openal installed
|
||||
* Compile with --disable-av to build without audio call support
|
||||
* Compile and install the program with ```make && sudo make install```
|
||||
### Audio dependencies
|
||||
* libtoxav
|
||||
* openal
|
||||
|
||||
#### Notes
|
||||
If your default prefix is /usr/local and you get the error: "error while loading shared libraries: libtoxcore.so.0: cannot open shared object file: No such file or directory", then you can try running ```sudo ldconfig```. If that doesn't fix it, run:
|
||||
### Compiling
|
||||
* `cd build/`
|
||||
* `make`
|
||||
* `sudo make install DESTDIR="/path/you/like"
|
||||
|
||||
* 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)
|
||||
|
||||
* Audio calling support is automatically enabled if all dependencies are found
|
||||
|
||||
### Troubleshooting
|
||||
If your default prefix is "/usr/local" and you get the error:
|
||||
`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`.
|
||||
If that doesn't fix it, run:
|
||||
```
|
||||
echo '/usr/local/lib/' | sudo tee -a /etc/ld.so.conf.d/locallib.conf
|
||||
sudo ldconfig
|
||||
```
|
||||
If you dont already have them, you may need to install the ncurses libraries. For Debian based systems:
|
||||
```
|
||||
sudo apt-get install libncurses5-dev libncursesw5-dev
|
||||
```
|
||||
|
||||
## 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: toxic/misc/toxic.conf
|
||||
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: [toxic/misc/toxic.conf](toxic/misc/toxic.conf).
|
||||
|
Loading…
Reference in New Issue
Block a user