Skip to content

Commit cde7781

Browse files
committed
Update README.md
1 parent 69e0680 commit cde7781

File tree

1 file changed

+58
-24
lines changed

1 file changed

+58
-24
lines changed

README.md

Lines changed: 58 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,82 @@
1-
# Speed Meter :signal_strength:
1+
# 📶 Speed Meter
22

3-
Lightweight Windows taskbar network monitor (upload/download speeds)
3+
**A lightweight network speed monitor for the Windows taskbar**
4+
Displays real-time upload/download speeds — simple, minimal, and effective.
45

5-
## Requirements
6-
- Python 3.7+
7-
- Windows 10/11
6+
---
87

9-
## Installation
8+
## 🛠 Requirements
9+
10+
* Windows 10 or 11
11+
* Python 3.7 or later (if running from source)
12+
13+
---
14+
15+
## 🚀 Installation
16+
17+
### ✅ Option 1: Run from Source
18+
19+
1. **Clone the repository:**
1020

11-
### Option 1: Run from Source
12-
1. Clone repo:
1321
```bash
1422
git clone https://github.com/Benojir/Networx-Alternative-Python.git
1523
cd Networx-Alternative-Python
1624
```
17-
2. Install dependencies:
25+
26+
2. **Install dependencies:**
27+
1828
```bash
1929
pip install -r requirements.txt
2030
```
21-
3. Run:
31+
32+
3. **Run the application:**
33+
2234
```bash
2335
python SpeedMeterApp.py
2436
```
2537

26-
### Option 2: Build Executable
27-
1. Install PyInstaller:
38+
---
39+
40+
### 🧱 Option 2: Build Executable Yourself
41+
42+
1. **Install PyInstaller:**
43+
2844
```bash
2945
pip install pyinstaller
3046
```
31-
2. Build (include icon):
47+
48+
2. **Build the executable:**
49+
3250
```bash
3351
pyinstaller --onefile --windowed --noconsole --clean --upx-exclude=vcruntime140.dll --add-data "speedmeter.ico;." SpeedMeterApp.py
3452
```
35-
3. Find executable and `install.bat` in `dist/` folder
36-
4. Double click on `install.bat`
3753

38-
### Option 3: Download Speed Meter Setup file
39-
1. Download the installer setup file from release page.
40-
2. Now double click and install the application.
54+
3. **Install the app:**
55+
56+
* Navigate to the `dist/` folder
57+
* Run `install.bat` to install the app
58+
59+
---
60+
61+
### 📦 Option 3: Download Prebuilt Installer
62+
63+
1. **Download** the installer from the [Releases](https://github.com/Benojir/Networx-Alternative-Python/releases) page.
64+
2. **Double-click** the setup file to install.
65+
66+
---
67+
68+
## 🧹 Uninstall
69+
70+
* Run `uninstall.bat` (if you used the installer), **or**
71+
* Manually delete:
72+
73+
* `%LOCALAPPDATA%\SpeedMeter`
74+
* Any created shortcuts
75+
76+
---
77+
78+
## ⚠️ Note
4179

42-
## Uninstall
43-
1. Run `uninstall.bat` (for installed versions)
44-
2. Or manually delete:
45-
- `%LOCALAPPDATA%\SpeedMeter` (config data)
46-
- Shortcuts (if created)
80+
Some antivirus software may flag the executable as a false positive. This happens because it was built using **PyInstaller**, a common tool that can trigger such warnings.
4781

48-
> **Note**: The released EXE may consider as false malware by antiviruses and the EXE was generated by Pyinstaller.
82+
---

0 commit comments

Comments
 (0)