168492376
/
qt-material-widgets
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

modify README, add useages into it

This commit is contained in:
tianxu 2024-02-23 17:58:11 +08:00
parent 252f20bbc6
commit caeb3cd776
1 changed files with 47 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@ -1,3 +1,50 @@
I've been using Qt for a while, the lack of UI framework is a big problem for me.
After building UI components from scratch for a while, I decided to try reusing other's projects, that is no piece of cake.
I found [qt-material-widgets](https://github.com/laserpants/qt-material-widgets), but sadly it seems to be no longer supported.
Pull requests from other developer, such as [move to cmake](https://github.com/laserpants/qt-material-widgets/pull/50) which inspired me on migrating this project from `qmake` to `CMake`, are not accepted anymore.
I'm very honored to try to take over the maintenance of this project, and welcome all pull requests and issues.
# Overview
The original project only supports the qmake build system on Linux platform.
The new project will support both qmake and CMake on as many platforms as possible, mainly Windows, Android ,Linux and MacOS.
# Usage
### 1. clone this project
### 2. create your widgets app
Create *Qt Widgets Application* with CMake project as normal
### 3. modify CMakeLists.txt of your app
First, add *component* as subdirectory of your project
```CMake
add_subdirectory(/path/to/qt-material-widgets/components/ ./components)
```
I'm not sure if these two line is really needed, you can add them when you count error
```CMake
set(CMAKE_INCLUDE_CURRENT_DIR ON) # I'm not sure if it is really needed
set(CMAKE_EXPORT_COMPILE_COMMANDS ON) # I'm not sure if it is really needed
```
then, add *include* and *link libraries*:
- add `/path/to/qt-material-widgets/include/qmeterial/` into `target_include_directories` for headers
- add `components` into `target_link_libraries` for `.lib`
Now you can use *qt-material-widgets*, all components list as follows:
# Qt Material Design Desktop Widgets [![Language](https://img.shields.io/badge/language-c++-brightgreen.svg)]() [![Join the chat at https://gitter.im/qt-material-widgets/Lobby](https://badges.gitter.im/qt-material-widgets/Lobby.svg)](https://gitter.im/qt-material-widgets/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
YouTube video preview [available here](http://www.youtube.com/watch?v=21UMeNVBPU4).