docs: docs and documentaion update

CONTRIBUTING.md

@@ -6,27 +6,20 @@ for more details. To avoid manual labor there is automatic cmake target named
 `clangformat` (see below). Some additional detail see below.
 
 * Indent is only spaces. 4 spaces.
-* Any private variable should start with `m_` prefix (`m_foo`). The only one
-  exception is `Ui` object which should be named as `ui`.
+* Any private variable should start with `m_` prefix (`m_foo`). The only one exception is `Ui` object which should be named as `ui`.
 * Avoid to create a large methods. Exception: if method contains lambda functions.
-* If some method is called only once, it is recommended to use lambda functions.
-  Exception is `Q_INVOKABLE` methods.
 * STL containers are not recommended, use Qt ones instead.
-* In other hand Qt specific variables types (`qint`, `qfloat`, etc) are not
-  recommended.
+* In other hand Qt specific variables types (`qint`, `qfloat`, etc) are not recommended.
 * Do not repeat yourself ([DRY](https://en.wikipedia.org/wiki/Don't_repeat_yourself)).
 * Headers declaration:
-    * Include only those headers which are strictly necessary inside headers. Use
-      forward class declaration instead. Exception is base class header declaration.
-    * In a`*.cpp` file header declaration should have the following order separated
-      by a new line in the alphabet order:
+    * Include only those headers which are strictly necessary inside headers. Use forward class declaration instead. Exception is base class header declaration.
+    * In a`*.cpp` file header declaration should have the following order separated by a new line in the alphabet order:
         1. Class header.
         2. KDE specific headers.
         3. Qt specific headers.
         4. Third party headers.
         5. Project headers.
-    * Any header should have [include guard](https://en.wikipedia.org/wiki/Include_guard)
-      named as `CLASSNAMECAPS_H`
+    * Any header should have `#pragma once`.
 * If any `#if` directive is used condition should be mentioned in `#endif`:
 
   ```
@@ -36,80 +29,60 @@ for more details. To avoid manual labor there is automatic cmake target named
   ```
 
 * `Q_PROPERTY` macro is allowed and recommended for QObject based classes.
-* Qt macros (e.g. `signals`, `slots`, `Q_OBJECT`, etc) are allowed. In other hand
-`Q_FOREACH` (`foreach`) is not allowed use `for (auto &foo : bar)` instead.
-* Current project standard is **C++17**.
+* Qt macros (e.g. `signals`, `slots`, `Q_OBJECT`, etc) are allowed. In other hand `Q_FOREACH` (`foreach`) is not allowed use `for (auto &foo : bar)` instead.
+* Current project standard is **C++23**.
 * Do not use C-like code:
-    * C-like style iteration if possible. Use `for (auto &foo : bar)` and
-      `std::for_each` instead if possible. It is also recommended to use iterators.
-    * C-like casts, use `const_cast`, `static_cast`, `dymanic_Cast` instead. Using
-      of `reinterpret_cast` is not recommended. It is highly recommended to use
-      `dynamic_cast` with the exception catching. It is also possible to use
-      `qvariant_cast` if required.
+    * C-like style iteration if possible. Use `for (auto &foo : bar)` and `std::for_each` instead if possible. It is also recommended to use iterators.
+    * C-like casts, use `const_cast`, `static_cast`, `dymanic_Cast` instead. Using of `reinterpret_cast` is not recommended. It is highly recommended to use `dynamic_cast` with the exception catching. It is also possible to use `qvariant_cast` if required.
     * C-like `NULL`, use `nullptr` instead.
-    * C-like constant definition, use `const vartype foo = bar` definition instead.
+    * C-like constant definition, use `static const vartype foo = bar` definition instead.
 * Abstract classes (which have at least one pure virtual method) are allowed.
-* Templates are allowed and recommended. Templates usually should be described
-  inside header not source code file.
-* Hardcode is not recommended. But it is possible to use cmake variables to
-  configure some items during build time.
+* Templates are allowed and recommended. Templates usually should be described inside header not source code file.
+* Hardcode is not recommended. But it is possible to use cmake variables to configure some items during build time.
 * Build should not require any additional system variable declaration/changing.
 * Any line should not end with space.
 * Do not hesitate move public methods to private one if possible.
-* Do not hesitate use `const` modifier. In other hand `volatile` modifier is not
-  recommended.
+* Do not hesitate use `const` modifier. In other hand `volatile` modifier is not recommended.
 * New lines rules:
     * One line after license header.
     * One line between header group declaration (see above).
-    * Two lines after header declaration and before declaration at the end of a
-      file.
+    * Two lines after header declaration and before declaration at the end of a file.
     * One line after class and types forward declarations in headers.
     * One line before each method modifiers (`public`, `public slots`, etc).
     * Two lines between methods inside source code (`*.cpp`).
     * One line after `qCDebug()` information (see below).
     * One line inside a method to improve code reading.
 * Each destructor should be virtual.
-* Class constructor should have default arguments. Use `QObject *parent` property
-  for QObject based classes.
+* Class constructor should have default arguments. Use `QObject *_parent` property for QObject based classes.
 * QObject based classes constructors should have explicit modifier.
 * Create one file (source and header) per class.
 * `else if` construction is allowed and recommended.
 * 'true ? foo : bar' construction is allowed and recommended for one-line assignment.
-* Any global pointer should be assign to `nullptr` after deletion and before
-  initialization. Exception: if object is deleted into class destructor.
+* Any global pointer should be assigned to `nullptr` after deletion and before initialization. Exception: if object is deleted into class destructor.
 * Do not use semicolon in qml files unless it is required.
 * Any method argument including class constructors should start with `_`.
 
 Comments
 --------
 
-Please do not hesitate to use comments inside source code (especially in non-obvious
-blocks). Comments also may use the following keywords:
+Please do not hesitate to use comments inside source code (especially in non-obvious blocks). Comments also may use the following keywords:
 
-* **TODO** - indicates that some new code should be implemented here later. Please
-  note that usually these methods should be implemented before the next release.
+* **TODO** - indicates that some new code should be implemented here later. Please note that usually these methods should be implemented before the next release.
 * **FIXME** - some dirty hacks and/or methods which should be done better.
-* **HACK** - hacks inside code which requires to avoid some restrictions and/or
-  which adds additional non-obvious optimizations.
+* **HACK** - hacks inside code which requires to avoid some restrictions and/or which adds additional non-obvious optimizations.
 
 Do not use dots at the end of the comment line.
 
 Development
 -----------
 
-* Officially the latest libraries versions should be used. In addition it is
-  possible to add workarounds for all versions (usually by using preprocessor
-  directives); in this case patches should be placed to `packages` directory.
+* Officially the latest libraries versions should be used. In addition, it is possible to add workarounds for all versions (usually by using preprocessor directives); in this case patches should be placed to `packages` directory.
 * Build should not contain any warning.
-* Try to minimize message in Release build with logging disabled. It is highly
-  recommended to fix KDE/Qt specific warning if possible
-* Do not use dependency to KDE libraries if there are no any strictly necessary.
-  Exceptions are KNotification and KI18n libraries.
+* Try to minimize message in Release build with logging disabled. It is highly recommended to fix KDE/Qt specific warning if possible
+* Do not use dependency to KDE libraries if there are no any strictly necessary. Exceptions are KNotification and KI18n libraries.
 * It is highly recommended to use submodules for third party libraries if possible.
-* The main branch is **development**. Changes in this branch may be merged to the
-  master one only if it is a 'stable' build.
-* For experimental features development new branch `feature-foo` creation is allowed
-  and recommended.
+* The main branch is **development**. Changes in this branch may be merged to the master one only if it is a 'stable' build.
+* For experimental features development new branch `feature-foo` creation is allowed and recommended.
 * Experimental features should be added inside `BUILD_FUTURE` definition:
 
   ```
@@ -118,54 +91,41 @@ Development
   #endif /* BUILD_FUTURE */
   ```
 
-* Any project specific build variable should be mentioned inside `version.h` as
-  well.
+* Any project specific build variable should be mentioned inside `version.h` as well.
 * Recommended compiler is `clang`.
 
 HIG
 ---
 
-The recommended HIG is [KDE one](https://techbase.kde.org/Projects/Usability/HIG).
-Avoid to paint interfaces inside plugin because QML and C++ parts may have different
-theming.
+The recommended HIG is [KDE one](https://techbase.kde.org/Projects/Usability/HIG). Avoid to paint interfaces inside plugin because QML and C++ parts may have different theming.
 
 Licensing
 ---------
 
-All files should be licensed under GPLv3, the owner of the license should be the
-project (i.e. **awesome-widgets**). See **Tools** section for more details.
+All files should be licensed under GPLv3, the owner of the license should be the project (i.e. **awesome-widgets**). See **Tools** section for more details.
 
 Logging
 -------
 
-For logging please use [QLoggingCategory](http://doc.qt.io/qt-5/qloggingcategory.html).
-Available categories should be declared in `awdebug.*` files. The following log
-levels should be used:
+For logging please use [QLoggingCategory](http://doc.qt.io/qt-5/qloggingcategory.html). Available categories should be declared in `awdebug.*` files. The following log levels should be used:
 
-* **debug** (`qCDebug()`) - method arguments information. Please note that it
-  is recommended to logging all arguments in the one line.
+* **debug** (`qCDebug()`) - method arguments information. Please note that it is recommended to logging all arguments in the one line.
 * **info** (`qCInfo()`) - additional information inside methods.
-* **warning** (`qCWarning()`) - not critical information, which may be caused by
-  mistakes in configuration for example.
-* **critical** (`qCCritical()`) - a critical error. After this error program may
-  be terminated.
+* **warning** (`qCWarning()`) - not critical information, which may be caused by mistakes in configuration for example.
+* **critical** (`qCCritical()`) - a critical error. After this error program may be terminated.
 
-The empty log string (e.g. `qCDebug();`) is not allowed because the method names
-will be stripped by compiler with `Release` build type. To log class constructor
-and destructor use `__PRETTY_FUNCTION__` macro.
+The empty log string (e.g. `qCDebug();`) is not allowed because the method names will be stripped by compiler with `Release` build type. To log class constructor and destructor use `__PRETTY_FUNCTION__` macro.
 
 Testing
 -------
 
-* Any changes should be tested by using `plasmawindowed` and `plasmashell` applications.
-  (It is also possible to use `plasmaengineexplorer` and `plasmoidviewer` in addition.)
+* Any changes should be tested by using `plasmawindowed` and `plasmashell` applications. (It is also possible to use `plasmaengineexplorer` and `plasmoidviewer` in addition.)
 * Any test should be performed on real (not Virtual Machine) system.
 * Test builds should be:
     1. `-DCMAKE_BUILD_TYPE=Debug`.
     2. `-DCMAKE_BUILD_TYPE=Debug -DBUILD_TESTING=ON`.
     3. `-DCMAKE_BUILD_TYPE=Release`.
-* Additional test functions should be declated and used only inside `BUILD_TESTING`
-  definition.
+* Additional test functions should be declated and used only inside `BUILD_TESTING` definition.
 
 Tools
 -----
@@ -222,7 +182,6 @@ Tools
         // declare with default value
         bool m_prop = false;
   ```
-* Use `cppcheck` to avoid common errors in the code. To start application just
-  run `make cppcheck`.
-* Use `clang-format` to apply valid code format. To start application just run
-  `make clangformat`.
+* Use `cppcheck` to avoid common errors in the code. To start application just run `make cppcheck`.
+* Use `clang-format` to apply valid code format. To start application just run `make clangformat`.
+* use `-DCMAKE_CXX_COMPILER=clang++` in order to enable clang-tidy checks.

README.md

@@ -14,11 +14,11 @@ A collection of minimalistic widgets which looks like Awesome Window Manager wid
 Features
 ========
 
-* easy and fully configurable native Plasma widget which may be used as Conky widget or as Awesome-like information panel
-* panel which shows active desktop status
-* clear Conky-like configuration with html tags support
+* easy and fully configurable native Plasma widget which may be used as desktop or panel widget
+* additionnal widget which shows active desktop status
+* clear text configuration with html tags support
 * custom command support (it may be simple action as well as special custom tag)
-* graphical item support - tooltips, bars
+* graphical widgets support - tooltips, bars
 
 See [links](#Links) for more details.
 
@@ -30,15 +30,11 @@ Instruction
 Dependencies
 ------------
 
-* plasma-framework
-* ksysguard (since plasma 5.22)
+* plasma-workspace
 
 Optional dependencies
 ---------------------
 
-* proprietary video driver
-* hddtemp
-* smartmontools
 * music player (mpd or MPRIS supported)
 * wireless_tools
 
@@ -48,19 +44,17 @@ Make dependencies
 * cmake
 * extra-cmake-modules
 
-In addition some distros might require to install some -dev packages, e.g. the list of required packages for deb-based distros can be found [here](https://github.com/arcan1s/awesome-widgets/blob/development/.docker/Dockerfile-ubuntu-amd64#L7).
+In addition, some distros might require to install some -dev packages, e.g. the list of required packages for deb-based distros can be found [here](https://github.com/arcan1s/awesome-widgets/blob/development/.docker/Dockerfile-ubuntu-amd64#L7).
 
 Installation
 ------------
 
 * download sources
-* install
+  * install
 
-        mkdir build && cd build
-        cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr ../sources
-        make && sudo make install
-
-  **NOTE** on Plasma 5 it very likely requires `-DKDE_INSTALL_USE_QT_SYS_PATHS=ON` flag
+          cmake -B build -S sources -DCMAKE_BUILD_TYPE=Release
+          cmake --build build
+          cmake --install build
 
 Additional information
 ======================

packages/PKGBUILD

@@ -9,7 +9,8 @@ arch=('x86_64')
 url="https://arcanis.me/projects/awesome-widgets"
 license=('GPL3')
 depends=('plasma-workspace')
-optdepends=("mpd: for music player monitor")
+optdepends=("mpd: for music player monitor"
+            "wireless_tools: wifi information")
 makedepends=('cmake' 'extra-cmake-modules' 'python')
 source=(https://github.com/arcan1s/awesome-widgets/releases/download/${pkgver}/${_pkgname}-${pkgver}-src.tar.xz)
 install="$pkgname.install"