Skip to content

Latest commit

 

History

History
61 lines (38 loc) · 1.7 KB

README.md

File metadata and controls

61 lines (38 loc) · 1.7 KB
Raw

Lan Chat crates.io Build Passing

Running example

Lan Chat is a terminal-based chat application featuring a user-friendly terminal interface.

Installation

This requires cargo to be installed on your target system. Refer to the cargo installation guide if cargo is absent on your system.

To install Lan Chat, use the following command:

cargo install lan-chat --locked

This will install the binary. For usage instructions, refer to the Usage section.

Alternatively, the project can be cloned and built using cargo.

Usage

  1. To learn about the available commands, run:
lan-chat --help
  1. To start the server, run:
lan-chat -i

The output will display the server IP.

  1. To connect to the server, use:
lan-chat -s <server-ip>

You will be prompted to enter a pseudonym. Alternatively, you can set the pseudonym directly using the following command:

lan-chat -s <server-ip> -p <pseudonym>
  1. To insert emojis in the chat, use the following format: :<emoji name>:. For example is you type That's funny :laughing: it will be rendered as That's funny 😂.

The supported emojis are as follows

Command Emoji
:smile: 😊
:laughing: 😂
:thumbsup: 👍
:cry: 😢

For all codes please refer to Emoji Cheat Sheet.