Skip to content

Commit c423269

Browse files
committed
update readme
1 parent 4413de0 commit c423269

File tree

1 file changed

+40
-19
lines changed

1 file changed

+40
-19
lines changed

README.md

+40-19
Original file line numberDiff line numberDiff line change
@@ -2,50 +2,71 @@
22

33
## About The Project
44

5-
This is a python application that quickly and easily enables the use of wireguard over TCP using [wstunnel](https://github.com/erebe/wstunnel)
5+
This is a Python application that quickly and easily enables the use of Wireguard over TCP using [wstunnel](https://github.com/erebe/wstunnel).
66

77
![alt text](images/screenshot.png)
88

99
## Getting Started
1010

1111
### Prerequisites
1212

13-
This script require the following software to be installed / downloaded:
13+
This script requires the following software to be installed/downloaded:
1414

15-
- [python3](https://www.python.org/downloads/)
15+
- [Python 3](https://www.python.org/downloads/)
1616
- [wstunnel](https://github.com/erebe/wstunnel/releases)
17-
- [wireguard](https://www.wireguard.com/install/)
17+
- [Wireguard](https://www.wireguard.com/install/)
18+
19+
## Build
20+
21+
To create a standalone binary using PyInstaller, follow these steps:
22+
23+
1. Download the latest [release](https://github.com/klementng/wireguard-over-wstunnel/releases/) source code or clone the main branch.
24+
2. Install dependencies:
25+
26+
```bash
27+
python -m pip install -r requirements.txt pyinstaller
28+
```
29+
30+
3. Build the binary:
31+
32+
```bash
33+
pyinstaller main.py --onefile --hide-console hide-late --uac-admin
34+
```
35+
36+
4. The output binary will be located in the `dist` directory.
37+
38+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
1839

1940
### Installation
2041

21-
_Using pyinstaller binaries_
42+
#### Using PyInstaller Binaries
2243

23-
1. Download latest [release](https://github.com/klementng/wireguard-over-wstunnel/releases/) binary
24-
2. Change permissions (for linux systems)
44+
1. Download the latest [release](https://github.com/klementng/wireguard-over-wstunnel/releases/) binary.
45+
2. Change permissions (for Linux systems):
2546

2647
```sh
27-
chmod +x ./main
48+
chmod +x ./main
2849
```
2950

30-
3. Edit the [config.yml](./config.yml)
31-
4. Start the program (double click on windows)
51+
3. Edit the [config.yml](./config.yml).
52+
4. Start the program (double-click on Windows):
3253

3354
```sh
34-
./main
55+
./main
3556
```
3657

37-
_Using source code_
58+
#### Using Source Code
3859

39-
1. Download latest [release](https://github.com/klementng/wireguard-over-wstunnel/releases/) source code
40-
2. Extract zip file
41-
3. Install required packages
60+
1. Download the latest [release](https://github.com/klementng/wireguard-over-wstunnel/releases/) source code.
61+
2. Extract the ZIP file.
62+
3. Install required packages:
4263

4364
```sh
44-
pip install -r requirements.txt
65+
pip install -r requirements.txt
4566
```
4667

47-
4. Edit the [config.yml](./config.yml)
48-
5. Start the program
68+
4. Edit the [config.yml](./config.yml).
69+
5. Start the program:
4970

5071
```sh
5172
python main.py
@@ -66,7 +87,7 @@ options:
6687
-h, --help show this help message and exit
6788
--config CONFIG, -c CONFIG
6889
path to program config
69-
--nogui start with no gui
90+
--nogui start with no GUI
7091
```
7192

7293
<p align="right">(<a href="#readme-top">back to top</a>)</p>

0 commit comments

Comments
 (0)