From b5af9279ed9faff0330a6a2710ca80a805f3c074 Mon Sep 17 00:00:00 2001 From: jfreegman Date: Fri, 20 Sep 2024 21:32:13 -0400 Subject: [PATCH] docs: update readme --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 58c7ea73b..5e162675c 100644 --- a/README.md +++ b/README.md @@ -3,19 +3,23 @@ src="https://scan.coverity.com/projects/4975/badge.svg"/> -Toxic is a [Tox](https://tox.chat)-based instant messaging and video chat client. +Toxic is a [Tox](https://tox.chat)-based peer-to-peer messenger that provides end-to-end encrypted communications without the use of centralized servers. It supports text messaging, file sharing, 1-on-1 voice and video calls, private audio conferences, public and private text group chats, and a few built-in games you can play with your friends. Toxic requires no registration or setup, and is ready to use out of the box. Its interface is highly customizable to suit your preferences. [![Toxic Screenshot](https://i.imgur.com/TwYA8L0.png "Toxic Home Screen")](https://i.imgur.com/TwYA8L0.png) ## Installation [See the install instructions](/INSTALL.md) +## Usage +As Toxic uses a text-based user interface, interacting with it involves a combination of navigation hotkeys and slash commands. For example, to navigate between open windows, use the `ctrl+o` and `ctrl+p` key combinations. Or to add a contact using their Tox address, use the command `/add {ADDRESS}` without the curly bracers. To see a full list of available commands and hotkeys, use the `/help` command or refer to the manual. + +Toxic also has a number of run options. For example, if you want to use a different profile than the default, you can run toxic with the `--file my_profile.toxic` flag. Or to disable UDP/direct connections, use the `--force-tcp` flag. To see all available options, run toxic with the `--help` flag, or refer to the manual. + ## 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. -You can view our example config file [here](misc/toxic.conf.example). +Running Toxic for the first time creates an empty file called toxic.conf in your home configuration directory (`~/.config/tox` for Linux users). You can use it to customize many aspects of the user interface, enable auto-logging, customize sound notifications, customize hotkeys, use custom names for your contacts, change the time format, and much more. You can view the example config file [here](misc/toxic.conf.example). ## Troubleshooting -If your default prefix is "/usr/local" and you receive the following: +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 ```