Skip to content

Commit c0a7879

Browse files
committed
Update README.md
1 parent 78e35b3 commit c0a7879

File tree

1 file changed

+25
-70
lines changed

1 file changed

+25
-70
lines changed

README.md

Lines changed: 25 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -1,106 +1,61 @@
1-
# BDIX FTP Tester
1+
# BDIX FTP TESTER
22

3-
A modern cross-platform application to test BDIX FTP links and show working servers. Built with Flutter, this application supports Windows, Linux, macOS, and Android.
3+
A cross-platform application to test and manage BDIX FTP servers.
44

55
## Features
66

7-
- Test multiple FTP links simultaneously
8-
- Modern and clean user interface
9-
- Dark and light theme support
10-
- Real-time response time monitoring
7+
- Test FTP server connections
8+
- Monitor server response times
119
- Cross-platform support (Windows, Linux, macOS, Android)
12-
- Automatic builds via GitHub Actions
10+
- Modern and intuitive user interface
1311

14-
## Installation
12+
## Downloads
1513

16-
### Windows
17-
1. Download the latest Windows release from the [Releases](../../releases) page
18-
2. Extract the ZIP file
19-
3. Run `bdix_ftp_tester.exe`
14+
You can download the latest version for your platform from the [Releases](../../releases) page.
2015

21-
### Linux
22-
1. Download the latest Linux release from the [Releases](../../releases) page
23-
2. Extract the archive
24-
3. Make the file executable: `chmod +x bdix_ftp_tester`
25-
4. Run the application: `./bdix_ftp_tester`
26-
27-
### macOS
28-
1. Download the latest macOS release from the [Releases](../../releases) page
29-
2. Mount the DMG file
30-
3. Drag the application to your Applications folder
31-
4. Run the application
32-
33-
### Android
34-
1. Download the latest APK from the [Releases](../../releases) page
35-
2. Install the APK on your Android device
36-
3. Run the application
37-
38-
## Development
16+
## Building from Source
3917

4018
### Prerequisites
19+
4120
- Flutter SDK (latest stable version)
42-
- For desktop development:
21+
- For desktop builds:
4322
- Windows: Visual Studio with C++ development tools
44-
- Linux: GTK development headers
23+
- Linux: GTK development libraries
4524
- macOS: Xcode
46-
- For Android development:
47-
- Android Studio
48-
- Android SDK
25+
- For Android builds: Android SDK and NDK
26+
27+
### Build Instructions
4928

50-
### Setup
5129
1. Clone the repository:
5230
```bash
53-
git clone https://github.com/FakeErrorX/bdix-ftp-tester.git
54-
cd bdix-ftp-tester
31+
git clone https://github.com/FakeErrorX/BDIX-FTP-TESTER.git
32+
cd BDIX-FTP-TESTER
5533
```
5634

5735
2. Get dependencies:
5836
```bash
5937
flutter pub get
6038
```
6139

62-
3. Run the application:
63-
```bash
64-
# For desktop
65-
flutter run -d windows
66-
flutter run -d linux
67-
flutter run -d macos
68-
69-
# For Android
70-
flutter run -d android
71-
```
72-
73-
## Building
74-
75-
The application is automatically built using GitHub Actions when:
76-
- A push is made to the main branch
77-
- A pull request is created targeting the main branch
78-
- A new release is created
79-
80-
To manually build the application:
81-
40+
3. Build for your platform:
8241
```bash
83-
# Windows
42+
# For Windows
8443
flutter build windows
8544

86-
# Linux
45+
# For Linux
8746
flutter build linux
8847

89-
# macOS
48+
# For macOS
9049
flutter build macos
9150

92-
# Android
51+
# For Android
9352
flutter build apk
9453
```
9554

96-
## Contributing
97-
98-
1. Fork the repository
99-
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
100-
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
101-
4. Push to the branch (`git push origin feature/amazing-feature`)
102-
5. Open a Pull Request
103-
10455
## License
10556

10657
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
58+
59+
## Contributing
60+
61+
Contributions are welcome! Please feel free to submit a Pull Request.

0 commit comments

Comments
 (0)