Skip to content

Commit ab9ef7b

Browse files
Update README.md
1 parent fe49a8e commit ab9ef7b

File tree

1 file changed

+24
-22
lines changed

1 file changed

+24
-22
lines changed

README.md

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,14 @@ This Software is designed to encrypt a Client's textfile and send it over a netw
44
# Usage
55
## Host
66
#### Port Number
7-
The Host must also enter a port number for the network
7+
The Host must enter a port number for the network socket
88

9-
The Host must communicate this number, as well as his/ her IP Address to the Client
9+
This port number, as well as the IP Address, must be provided to the Client
1010

1111
For example:
1212
```
1313
Enter port number: 1234
1414
```
15-
16-
#### Running to Software
17-
The Host must run 'HostGUI.py'
18-
19-
This can be done by running the following while in the project root:
20-
``` bash
21-
$ ./scripts/run_host.sh
22-
```
23-
24-
The Host may now set up a network socket
25-
26-
![alt text][socket]
27-
28-
Only after a socket is made, may a host generate a key pair for encryption
29-
30-
![alt text][key_gen]
31-
32-
The Host may now click 'Establish connection; send and recieve data' to wait for a Client to connect
33-
3415
## Client
3516
#### Saving your data
3617
To begin using this software to encrypt a message, the Client must save their desired data as a text file in:
@@ -49,7 +30,27 @@ For example:
4930
Enter Host IP Address: 192.168.0.19
5031
Enter port number: 1234 (matches the Host's port number)
5132
```
52-
#### Running to Software
33+
34+
### Running to Software
35+
##### Host
36+
The Host must run 'HostGUI.py'
37+
38+
This can be done by running the following while in the project root:
39+
``` bash
40+
$ ./scripts/run_host.sh
41+
```
42+
43+
The Host may now set up a network socket
44+
45+
![alt text][socket]
46+
47+
Only after a socket is made, may a host generate a key pair for encryption
48+
49+
![alt text][key_gen]
50+
51+
The Host may now click 'Establish connection; send and recieve data' to wait for a Client to connect
52+
53+
##### Client
5354
The Client must run 'ClientGUI.py'
5455
This can be done by running the following while in the project root:
5556
``` bash
@@ -59,6 +60,7 @@ The Client may then choose to encrypt and send their message to the Host to be d
5960

6061
![alt text][client]
6162

63+
6264
### Running on an IDE or Shell
6365
Useful information relating to the encryption/ decryption processes and connection statuses will be printed to the screen for both the Host and Client
6466

0 commit comments

Comments
 (0)