minhcord/README.md
minhtrannhat 833c7066ac Update 'README.md'
Signed-off-by: minhtrannhat <minh@minhtrannhat.com>
2023-12-15 00:54:31 +00:00

21 lines
563 B
Markdown

# MINH_CORD
A wannabe discord clone but currently only support chatting via TCP sockets with the help of `tokio` Rust async runtime.
## Dependencies
- `rust`
- `telnet`
## Installation
- Run `cargo build` at project root to build the binary.
## Running
### Development
- Run the server with `cargo run` or `RUST_LOG=debug cargo run` to run with debug.
### Production
- Run the binary with `./minh_cord`.
## Connecting to the server
- Run the server with the above commands.
- Run `telnet {SERVER_INTERNAL_IP_ADDRESS}` from a client to connect to the server.