|
1 | | -# Speed Meter :signal_strength: |
| 1 | +# 📶 Speed Meter |
2 | 2 |
|
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. |
4 | 5 |
|
5 | | -## Requirements |
6 | | -- Python 3.7+ |
7 | | -- Windows 10/11 |
| 6 | +--- |
8 | 7 |
|
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:** |
10 | 20 |
|
11 | | -### Option 1: Run from Source |
12 | | -1. Clone repo: |
13 | 21 | ```bash |
14 | 22 | git clone https://github.com/Benojir/Networx-Alternative-Python.git |
15 | 23 | cd Networx-Alternative-Python |
16 | 24 | ``` |
17 | | -2. Install dependencies: |
| 25 | + |
| 26 | +2. **Install dependencies:** |
| 27 | + |
18 | 28 | ```bash |
19 | 29 | pip install -r requirements.txt |
20 | 30 | ``` |
21 | | -3. Run: |
| 31 | + |
| 32 | +3. **Run the application:** |
| 33 | + |
22 | 34 | ```bash |
23 | 35 | python SpeedMeterApp.py |
24 | 36 | ``` |
25 | 37 |
|
26 | | -### Option 2: Build Executable |
27 | | -1. Install PyInstaller: |
| 38 | +--- |
| 39 | + |
| 40 | +### 🧱 Option 2: Build Executable Yourself |
| 41 | + |
| 42 | +1. **Install PyInstaller:** |
| 43 | + |
28 | 44 | ```bash |
29 | 45 | pip install pyinstaller |
30 | 46 | ``` |
31 | | -2. Build (include icon): |
| 47 | + |
| 48 | +2. **Build the executable:** |
| 49 | + |
32 | 50 | ```bash |
33 | 51 | pyinstaller --onefile --windowed --noconsole --clean --upx-exclude=vcruntime140.dll --add-data "speedmeter.ico;." SpeedMeterApp.py |
34 | 52 | ``` |
35 | | -3. Find executable and `install.bat` in `dist/` folder |
36 | | -4. Double click on `install.bat` |
37 | 53 |
|
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 |
41 | 79 |
|
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. |
47 | 81 |
|
48 | | -> **Note**: The released EXE may consider as false malware by antiviruses and the EXE was generated by Pyinstaller. |
| 82 | +--- |
0 commit comments