Skip to content

Commit

Permalink
Add a changelog.
Browse files Browse the repository at this point in the history
  • Loading branch information
Alexhuszagh committed Sep 8, 2024
1 parent 00feeda commit 8460d78
Show file tree
Hide file tree
Showing 2 changed files with 72 additions and 22 deletions.
63 changes: 63 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog],
and this project adheres to [Semantic Versioning].

## [Unreleased]

### Added

- Detection of system theme (light or dark mode).
- Support for PySide2 and PySide6 frameworks (from [Inverted-E]).
- Support for flat groupboxes.
- Advanced Docking System styling.
- Examples for title bars, standard icon overrides, LCD displays, and more.
- Configurable stylesheets via themes.
- Custom extension support, such as the advanced docking system.
- Compile Qt resource files (from [chaosink]).

### Changed

- Stylesheets to match KDE-like Breeze and Breeze dark themes.
- Icons to match KDE-like Breeze and Breeze dark themes.

### Deprecated

### Removed

- Old PyQt6 packaging system to match the standard Qt5 and Qt6 approach using resource compilers (from [Inverted-E]).
- The `--no-qrc` flag when configuring stylesheets due to the new RCC system (from [Inverted-E]).
- The QRC dist files due to the new RCC system (from [Inverted-E]).

### Fixed

- Documentation for CMake installation.
- QTableWidget::indicator size to match other checkboxes (from [Inverted-E]).
- Menu bar hover styling.
- Qt6 support.
- Branch indicators for QTreeView and QTreeWidget (from [eblade]).

<!-- Unused Sections -->
<!-- ### Security -->

<!-- Initial release
## [0.0.1] - 2024-09-08
- Initial release
-->

<!-- Links -->
[Keep A Changelog]: https://keepachangelog.com/en/1.0.0/
[Semantic Versioning]: https://semver.org/spec/v2.0.0.html

<!-- Versions -->
[Unreleased]: https://github.com/Author/Repository/compare/v0.0.2...HEAD
<!-- [0.0.1]: https://github.com/Author/Repository/releases/tag/v0.0.1 -->

<!-- Contributors -->
[Inverted-E]: https://github.com/Inverted-E/
[eblade]: https://github.com/eblade/
[chaosink]: https://github.com/chaosink/
31 changes: 9 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,11 @@ BreezeStyleSheets is a set of beautiful light and dark stylesheets that render c
- [Linting and Type Checks](#linting-and-type-checks)
- [Distribution Files](#distribution-files)
- [Git Ignore](#git-ignore)
9. [What's changed in this fork?](#whats-changed-in-this-fork)
10. [Known Issues and Workarounds](#known-issues-and-workarounds)
11. [License](#license)
12. [Contributing](#contributing)
13. [Acknowledgements](#acknowledgements)
14. [Contact](#contact)
9. [Known Issues and Workarounds](#known-issues-and-workarounds)
10. [License](#license)
11. [Contributing](#contributing)
12. [Acknowledgements](#acknowledgements)
13. [Contact](#contact)

## Gallery

Expand Down Expand Up @@ -554,21 +553,6 @@ git add .gitignore
git commit -m "..."
```

## What's changed in this fork?

- Added support for PySide2 and PySide6.
- Removed old PyQt6 packaging system and replaced with an identical process for the four most common Python Qt frameworks.
- This is achieved by using PySide6-rcc. New function was added to change import from 'PySide6' to 'PyQt6' when building for PyQt6.
- Error message added if required rcc executable is not found.
- Altered '--no-qrc' option. Compiled resources will now still build if this option is selected as long as a qrc file already exists.
- Error message presented if no qrc file is present and '--no-qrc' option is selected.
- Removed 'qrc dist' as no longer needed to separate PyQt6 files. All files now built in 'dist'.
- Changed function spacing to align with PEP-8 (two new lines between functions).

```bash
python configure.py --compiled-resource=breeze_resources.py --qt-framework=pyqt6
```

## Known Issues and Workarounds

For known issues and workarounds, see [issues](/ISSUES.md).
Expand All @@ -579,14 +563,17 @@ MIT, see [license](/LICENSE.md).

## Contributing

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in BreezeStyleSheets by you shall be licensed under the MIT license without any additional terms or conditions.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in BreezeStyleSheets by you shall be licensed under the MIT license without any additional terms or conditions. See the [changelog](/CHANGELOG.md) for changes and contributors to the project.

## Acknowledgements

BreezeStyleSheets is a fork of [QDarkStyleSheet](https://github.com/ColinDuquesnoy/QDarkStyleSheet). Some of the icons are modified from [Material UI](https://github.com/google/material-design-icons) and [Material Design Icons](https://materialdesignicons.com/) (both of which use an Apache 2.0 [license](/MaterialUi.LICENSE)), and are redistributed under the MIT license.

PyQtBreezeStyleSheets is a further fork of [BreezeStyleSheets](https://github.com/Alexhuszagh/BreezeStyleSheets).

Major contributions to the project have made by:
- [Inverted-E](https://github.com/Inverted-E/)

## Contact

Email: [[email protected]](mailto:[email protected])
Expand Down

0 comments on commit 8460d78

Please sign in to comment.