Skip to content

Commit ae73f3c

Browse files
authored
Add Quick Installation Guide
1 parent 1c0e2a7 commit ae73f3c

File tree

1 file changed

+41
-5
lines changed

1 file changed

+41
-5
lines changed

README.md

Lines changed: 41 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,20 @@
22

33
An easy to use real time file synchronization application built using Python.
44
<img src="https://user-images.githubusercontent.com/43802499/68604424-71f7df00-04d0-11ea-9773-1d51344c8318.png" align="right"
5-
title="File-Sync" width="220" height="250">
5+
title="Interact" width="35%" height="20%">
66

77
## Getting Started
88

9-
These instructions will get you a copy of the project and ready for on your local machine.
9+
These instructions will get you a copy of the project and ready for use on your local machine.
1010

1111
### Prerequisites
12+
13+
#### Quick Access
14+
- Click on the link to download the tool - [Interact.zip](https://github.com/KrishnanSG/Interact/files/3835348/Interact.zip)
15+
16+
- Extract the zip folder
17+
18+
#### Developer Style
1219
- Python 3.7
1320

1421
- Clone this repository using the command:
@@ -29,6 +36,24 @@ These instructions will get you a copy of the project and ready for on your loca
2936
You're almost there.
3037
The following steps will guide you on how to use this tool.
3138
39+
#### Quick Access
40+
> Use the following commands if you have downloaded the tool using steps described in quick access.
41+
42+
1. Open your favourite terminal
43+
44+
2. Creating host server
45+
```
46+
./Interact.exe <filename> --host
47+
```
48+
3. Ask your friend to connect to the server
49+
```
50+
./Interact <filename>
51+
52+
Provide inputs for the prompt messages.
53+
```
54+
55+
#### Developer Stlye
56+
3257
1. Creating host server
3358
```
3459
python main.py <filename> --host
@@ -41,18 +66,29 @@ The following steps will guide you on how to use this tool.
4166
Provide inputs for the prompt messages.
4267
```
4368
44-
3. Enjoy the sync. We automatically detect for modification made in the file, so just save the file.
69+
3. Enjoy Interact :) . We automatically detect for modification made in the file, so just save the file.
70+
71+
> You may use the following command to get help regarding the tool
72+
```
73+
./Interact.exe --help or python main.py --help
74+
```
4575
4676
## How does this work?
4777
48-
Most the of the file synchronziers send the complete file across the network for every sync cycle.
78+
Most of the file synchronziers send the complete file across the network for every sync cycle, this causes unnecessary data transfer.
79+
80+
Let's consider this case where you make a modification on line 10 but your file containing 1000 lines is sent across the network.
81+
82+
" To solve this problem **Interact** was developed. "
4983
5084
### How we do it?
51-
**BloomFilters**
85+
86+
**BloomFilter**
5287
5388
A Bloom filter is a space-efficient probabilistic data structure that is used to test whether an element is a member of a set. Check out this [link](https://www.geeksforgeeks.org/bloom-filters-introduction-and-python-implementation/) to know more.
5489
5590
### The protocol
91+
5692
We will be using a few terms in the due course of the explanation.
5793
- **Host** - the user who has intiated the P2P server.
5894
- **Client** - the user who connects to the host.

0 commit comments

Comments
 (0)