update readme
This commit is contained in:
13
README.md
13
README.md
@@ -2,11 +2,8 @@
|
|||||||
|
|
||||||
## TODO
|
## TODO
|
||||||
|
|
||||||
- Finalize coding style,
|
- Improve documentation
|
||||||
- **see [STYLE.md](STYLE.md)**
|
- Fix cursor going in the wrong place when either user receives a message
|
||||||
- Get everyone's editors set up for clangd/clang-format and git
|
|
||||||
- Make sure everyone's compiler toolchains work
|
|
||||||
- Assign responsibilities to each team member
|
|
||||||
|
|
||||||
## Build
|
## Build
|
||||||
|
|
||||||
@@ -17,11 +14,13 @@ make
|
|||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
```
|
```
|
||||||
./ct # run as server
|
./ct -m server # run as server
|
||||||
```
|
```
|
||||||
|
|
||||||
```
|
```
|
||||||
./ct client # run as client
|
./ct -m client # run as client
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Running the program without any options will print a help page with more information.
|
||||||
|
|
||||||
Chat logs are stored in `./server.txt` and `./client.txt`.
|
Chat logs are stored in `./server.txt` and `./client.txt`.
|
||||||
|
|||||||
Reference in New Issue
Block a user