mirrors/QtAwesome
1
0
Fork 0
mirror of https://github.com/gamecreature/QtAwesome.git synced 2024-11-15 13:35:44 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Readme improvements

Browse Source
This commit is contained in:
Rick Blommers 2022-12-27 20:49:56 +01:00
parent 5364094fb6
commit 25466bfb43
1 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -1,4 +1,4 @@
# QtAwesome - Font Awesome support for Qt applications # QtAwesome - Font Awesome for Qt Applications
QtAwesome is a library to add [Font Awesome](http://fortawesome.github.io/Font-Awesome/) QtAwesome is a library to add [Font Awesome](http://fortawesome.github.io/Font-Awesome/)
icons to your [Qt application](http://qt-project.org/). icons to your [Qt application](http://qt-project.org/).
@ -10,10 +10,10 @@ icons to your [Qt application](http://qt-project.org/).
- [Installation Pro version](#installation-pro-version) - [Installation Pro version](#installation-pro-version)
- [Basic Usage](#basic-usage) - [Basic Usage](#basic-usage)
- [Examples](#examples) - [Examples](#examples)
- [Example custom painter](#example-custom-painter) - [Example Custom Painter](#example-custom-painter)
- [Default options](#default-options) - [Default options](#default-options)
- [Known Issues And Workarounds](#known-issues-and-workarounds) - [Known Issues And Workarounds](#known-issues-and-workarounds)
- [Summary Of Changes](#summary-of-changes) - [Summary of Changes](#summary-of-changes)
- [Thanks](#thanks) - [Thanks](#thanks)
- [Contact](#contact) - [Contact](#contact)
- [License](#license) - [License](#license)
@ -120,8 +120,7 @@ QLabel* label = new QLabel(QChar(fa::fa_github));
label->setFont(awesome->font(fa::fa_brands, 16)); label->setFont(awesome->font(fa::fa_brands, 16));
``` ```
## Example Custom Painter
## Example custom painter
This example registers a custom painter for supporting an custom icon named 'duplicate' This example registers a custom painter for supporting an custom icon named 'duplicate'
It simply draws 2 "plus marks". It simply draws 2 "plus marks".
@ -250,13 +249,13 @@ QAction* menuAction = new QAction("test");
menuAction->setIcon(awesome->icon(fa::fa_heart).pixmap(32,32)); menuAction->setIcon(awesome->icon(fa::fa_heart).pixmap(32,32));
``` ```
## Summary Of Changes ## Summary of Changes
- The complete icons set is renewed and is generated - The complete icons set is renewed and is generated
- Everything is namespaced in the `fa` namespace - Everything is namespaced in the `fa` namespace
- Icon name enumerations are changed so the full Font Aweomse name is used: `fa::user` => `fa::fa_user`. - Icon name enumerations are changed so the full Font Aweomse name is used: `fa::user` => `fa::fa_user`.
With the dashes replaced by underscores. With the dashes replaced by underscores.
- Font Awesome 6 full stylenames, like `fa::fa_regular`, `fa::fa_solid` - Font Awesome 6 full style names, like `fa::fa_regular`, `fa::fa_solid`
- This release has been tested with Qt 5 and Qt 6. - This release has been tested with Qt 5 and Qt 6.
## Thanks ## Thanks