comment on everything
This commit is contained in:
		
							
								
								
									
										20
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										20
									
								
								README.md
									
									
									
									
									
								
							| @@ -29,12 +29,30 @@ source .venv/bin/activate | ||||
|  | ||||
| ### Client | ||||
|  | ||||
| To run the client with a localhost target: | ||||
|  | ||||
| ```shell | ||||
| python -m client | ||||
| ``` | ||||
|  | ||||
| To target an external server, provide its IP address using the `-s` flag: | ||||
|  | ||||
| ```shell | ||||
| python -m client -s [server IP address] | ||||
| ``` | ||||
|  | ||||
| ### Server | ||||
|  | ||||
| ```shell | ||||
| python -m server | ||||
| ``` | ||||
| ``` | ||||
|  | ||||
| ### Common Flags | ||||
|  | ||||
| Make sure that these match between your client and server!! | ||||
|  | ||||
| | Short | Long | Description | Default | | ||||
| |-------|---|---|---| | ||||
| | `-p`  | `--port` | The port for the client / server to communicate on. | `5005` | | ||||
| | `-W`  | `--width` | Image width in pixels. | `640` | | ||||
| | `-H` | `--height` | Image height in pixels. | `480` | | ||||
		Reference in New Issue
	
	Block a user