Skip to content

Commit 68d7ee1

Browse files
committed
docs: update README with app screenshot and simplified installation instructions
1 parent 5671aa1 commit 68d7ee1

File tree

5 files changed

+15
-13
lines changed

5 files changed

+15
-13
lines changed

README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
A cross-platform desktop GUI application built with Go and Fyne v2 for managing database synchronizations. It allows you to export large databases from remote Linux servers via SSH, WordPress sites, or Docker containers, and restore them efficiently.
44

5+
6+
![DB Sync Manager Screenshot](desgin/app.png)
7+
58
## Features
69

710
### 🔌 Connectivity
@@ -27,30 +30,29 @@ A cross-platform desktop GUI application built with Go and Fyne v2 for managing
2730

2831
## Installation & Running
2932

30-
### Option 1: Run via Docker (Recommended)
31-
Avoid system dependency issues (missing X11/GL headers) by running the app in a container.
32-
33-
```bash
34-
./docker-run.sh
35-
```
36-
*The app will appear on your desktop via X11 forwarding.*
37-
38-
### Option 2: Run Locally (Linux)
39-
Requires `gcc`, `libgl1-mesa-dev`, and `xorg-dev`.
33+
### Run via Script (Linux)
34+
This script handles dependency checks and runs the application.
4035

4136
```bash
42-
sudo apt-get install libgl1-mesa-dev xorg-dev
4337
./run.sh
4438
```
39+
*Note: You may need to install `gcc`, `libgl1-mesa-dev`, and `xorg-dev` if prompted.*
4540

46-
### Option 3: Build Binaries
41+
### Build Binaries
4742
To generate standalone executables for Linux and Windows:
4843

4944
```bash
5045
./build.sh
5146
```
5247
*Artifacts will be created as `dback-linux` and `dback-windows.exe`.*
5348

49+
### Docker Alternative
50+
If you have issues with system dependencies, you can run the app in a container:
51+
52+
```bash
53+
./docker-run.sh
54+
```
55+
5456
## WordPress Integration Guide
5557

5658
1. Open the **Export** tab.
@@ -64,4 +66,4 @@ To generate standalone executables for Linux and Windows:
6466
## FAQ
6567

6668
### Why does this app require X11/GL libraries?
67-
This application is built using **Fyne**, a high-performance GUI toolkit for Go. Fyne uses **OpenGL** to render its graphics (GPU acceleration). On Linux, interfacing with OpenGL and creating windows requires the **X11** and **OpenGL** development headers. Using the Docker method (`./docker-run.sh`) bypasses this requirement on your host machine.
69+
This application is built using **Fyne**, a high-performance GUI toolkit for Go. Fyne uses **OpenGL** to render its graphics (GPU acceleration). On Linux, interfacing with OpenGL and creating windows requires the **X11** and **OpenGL** development headers.

desgin/app.png

83.5 KB
Loading

desgin/export.jpeg

-460 KB
Binary file not shown.

desgin/import.jpeg

-529 KB
Binary file not shown.

desgin/log.jpeg

-643 KB
Binary file not shown.

0 commit comments

Comments
 (0)