Skip to content

Commit 5d05d30

Browse files
authored
Update README.md
1 parent 53754de commit 5d05d30

File tree

1 file changed

+91
-2
lines changed

1 file changed

+91
-2
lines changed

README.md

+91-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,98 @@
11
# AnyPC Client
2-
Created by Alon Horesh and Ilai Keinan.
2+
3+
AnyPC is a software application that enables users to gain full control of computers remotely. This repository contains the client version of AnyPC, implemented in Python.
4+
5+
Client created by Alon Horesh.
6+
Server created by Ilai Keinan.
37

48
Server is at [K9Developer/AnyPC](https://github.com/K9Developer/AnyPC).
59

6-
## WRPC Protocol
10+
## Table of Contents
11+
12+
- [Description](#description)
13+
- [Features](#features)
14+
- [Technologies](#technologies)
15+
- [Protocol](#protocol)
16+
- [Setup](#setup)
17+
- [Usage](#usage)
18+
- [Contributing](#contributing)
19+
- [License](#license)
20+
21+
## Description
22+
23+
AnyPC allows users to remotely access and control computers from anywhere in the world. This client version connects to the AnyPC server, providing a seamless and secure remote control experience.
24+
25+
## Features
26+
27+
- Remote desktop control
28+
- File transfer between client and server
29+
- Secure communication with encryption
30+
- Cross-platform support
31+
32+
## Technologies
33+
34+
- **Python**: The entire client application is developed using Python.
35+
36+
## Protocol
737
WRPC is the protocol we've designed and implemented to allow for a smooth experience of controlling remote computers over the network.
838

939
The protocol documentation can be found [here](https://github.com/AlonHor/AnyPC/blob/master/WRPC.pdf).
40+
41+
## Setup
42+
43+
To set up the project locally, follow these steps:
44+
45+
1. Clone the repository:
46+
```bash
47+
git clone https://github.com/AlonHor/AnyPC.git
48+
```
49+
50+
2. Navigate to the project directory:
51+
```bash
52+
cd AnyPC
53+
```
54+
55+
3. Create a virtual environment and activate it:
56+
```bash
57+
python -m venv venv
58+
source venv/bin/activate # On Windows use `venv\Scripts\activate`
59+
```
60+
61+
4. Install the required dependencies:
62+
```bash
63+
pip install -r requirements.txt
64+
```
65+
66+
## Usage
67+
68+
To start using the AnyPC client, run the main application script:
69+
70+
```bash
71+
python main.py
72+
```
73+
74+
Follow the on-screen instructions to connect to the AnyPC server and start controlling a remote computer.
75+
76+
## Contributing
77+
78+
We welcome contributions to the AnyPC project. To contribute, please follow these steps:
79+
80+
1. Fork the repository.
81+
2. Create a new branch with a descriptive name:
82+
```bash
83+
git checkout -b my-feature-branch
84+
```
85+
3. Make your changes.
86+
4. Commit your changes with a meaningful commit message:
87+
```bash
88+
git commit -m "Add new feature"
89+
```
90+
5. Push your changes to your fork:
91+
```bash
92+
git push origin my-feature-branch
93+
```
94+
6. Open a pull request to the `main` branch of the original repository.
95+
96+
## License
97+
98+
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.

0 commit comments

Comments
 (0)