Skip to content

Commit ebe4367

Browse files
committed
docs(README.md): update README file
1 parent 1815890 commit ebe4367

File tree

1 file changed

+24
-18
lines changed

1 file changed

+24
-18
lines changed

README.md

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
1-
# QSqlBrowser
1+
![Build Status](https://github.com/n0f4ph4mst3r/qSQLbrowser/actions/workflows/ccpp-windows-x64.yml/badge.svg)
2+
![Build Status](https://github.com/n0f4ph4mst3r/qSQLbrowser/actions/workflows/ccpp-ubuntu-gcc.yml/badge.svg)
3+
![Build Status](https://github.com/n0f4ph4mst3r/qSQLbrowser/actions/workflows/ccpp-ubuntu-clang.yml/badge.svg)
4+
![Github Releases](https://img.shields.io/github/v/release/n0f4ph4mst3r/qSQLbrowser)
5+
6+
# qSQLbrowser
27
Description
38
-----------
4-
Sql Browser for visualizing the results of SQL statements on a live database.
9+
Browser for visualizing the results of SQL statements on a live database.
510

611
Build
712
-----
@@ -22,7 +27,7 @@ On Linux, `cmake` is usually available from the system package manager. Alternat
2227
### Vcpkg
2328
Clone the repo with the `--recurse-submodules` flag
2429

25-
git clone --recurse-submodules https://github.com/n0f4ph4mst3r/SimpleFTP
30+
git clone --recurse-submodules https://github.com/n0f4ph4mst3r/qSQLbrowser
2631

2732
Run `./vcpkg/bootstrap-vcpkg.sh` or `.\vcpkg\bootstrap-vcpkg.bat`.
2833

@@ -36,7 +41,7 @@ I build using Microsoft Visual Studio 2022. However, it is likely possible to bu
3641
I use Clang 15, but any compilers supporting C++ 20 functions should work. Also, `qtbase` requires packages from the system package manager. They
3742
can be installed on Ubuntu systems via:
3843

39-
sudo apt-get install '^libxcb.*-dev' libx11-xcb-dev libglu1-mesa-dev libxrender-dev libxi-dev libxkbcommon-dev libxkbcommon-x11-dev
44+
sudo apt-get install autoconf-archive '^libxcb.*-dev' libx11-xcb-dev libglu1-mesa-dev libxrender-dev libxi-dev libxkbcommon-dev libxkbcommon-x11-dev
4045

4146

4247
#### Building on Windows
@@ -45,9 +50,9 @@ can be installed on Ubuntu systems via:
4550

4651
For example, in the git-bash run:
4752

48-
git clone --recurse-submodules https://github.com/n0f4ph4mst3r/QSqlBrowser
53+
git clone --recurse-submodules https://github.com/n0f4ph4mst3r/qSQLbrowser
4954

50-
2. Run `.\vcpkg\bootstrap-vcpkg.bat`.
55+
2. Run `.\vcpkg\bootstrap-vcpkg.bat -disableMetrics`.
5156

5257
3. Configure project using CMake:
5358

@@ -56,18 +61,25 @@ For example, in the git-bash run:
5661

5762
4. Open Visual Studio project:
5863

59-
$ .\\QSqlBrowser.sln
64+
$ .\qSQLbrowser.sln
6065

6166
and build using the IDE.
62-
67+
68+
5. Deploy Qt libraries using `windeployqt.exe`:
69+
70+
$ .\vcpkg_installed\x64-windows-mixed\tools\Qt6\bin\windeployqt.exe .\Release\qSQLbrowser.exe
71+
72+
For debug configuration use `windeployqt.debug.bat`:
73+
74+
$ .\vcpkg_installed\x64-windows-mixed\tools\Qt6\bin\windeployqt.debug.bat .\Debug\qSQLbrowser.exe
6375

6476
#### Linux
6577

6678
1. Clone repository from GitHub project.
6779

68-
git clone --recurse-submodules https://github.com/n0f4ph4mst3r/QSqlBrowser
80+
git clone --recurse-submodules https://github.com/n0f4ph4mst3r/qSQLbrowser
6981

70-
2. Run `./vcpkg/bootstrap-vcpkg.sh`.
82+
2. Run `./vcpkg/bootstrap-vcpkg.sh -disableMetrics`.
7183

7284
3. Configure project using CMake:
7385

@@ -82,15 +94,9 @@ For example, in the git-bash run:
8294

8395
4. Install project
8496

85-
Makefiles:
86-
87-
$ make install
88-
89-
Ninja:
90-
91-
$ ninja install
97+
$ cmake --install .
9298

9399
5. Test the build:
94100

95101
$ cd ../bin
96-
$ ./QSqlBrowser
102+
$ ./qSQLbrowser

0 commit comments

Comments
 (0)