minhcord/README.md

21 lines
563 B
Markdown
Raw Permalink Normal View History

2022-08-18 09:45:41 -04:00
# MINH_CORD
A wannabe discord clone but currently only support chatting via TCP sockets with the help of `tokio` Rust async runtime.
2022-08-18 09:45:41 -04:00
## 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`.
2022-08-18 09:45:41 -04:00
## 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.