mirror of
https://github.com/Xevion/tcp-chat.git
synced 2025-12-06 03:16:44 -06:00
Update README
This commit is contained in:
33
README.md
Normal file
33
README.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# tcp-chat
|
||||
|
||||
A little experiment with python's `socket` module expanded with `sqlite3`, `threading`,
|
||||
and `pyqt5` to create a simple server & client chat mimicking IRC.
|
||||
|
||||
## Installation
|
||||
|
||||
Create and activate a environment if needed, then install the project requirements:
|
||||
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
I like to use Windows Terminal to run both a server and client simultaneously inside one window.
|
||||
|
||||
```bash
|
||||
wt -d . -p "Command Prompt" ; sp -d . -p "Command Prompt"
|
||||
```
|
||||
|
||||
Then in each pane, run the client:
|
||||
```bash
|
||||
python launch.py c
|
||||
```
|
||||
and the server:
|
||||
```bash
|
||||
python launch.py s
|
||||
```
|
||||
|
||||
## To-do List
|
||||
|
||||
Expand to-do list
|
||||
Reference in New Issue
Block a user