lychee-declarative

provides a lychee-customized way to create user interfaces. It is based on the QML (Qt Meta-Object Language) language, which allows developers to define the appearance and behavior of the user interface in a simple and extensible way,guidelines are based on performance and supplemented by design.

Release Signatures

Installation

Run these commands to make install :

    mkdir build
    cd build
    cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug ..
    // j8 mean 8 CPUs, which can be set freely according to the device hardware
    sudo make install -j8

doxygen

Execute "make doc" or "cmake --build <build_dir> --target doc" in the build directory to generate Doxygen documentation.

From Packages

Compiling from Source

Install dependencies:

build dependencies(for arch linux):

• cmake
• pkgconfig
• git
• extra-cmake-modules
• qt6-base
• qt6-declarative
• mesa
• libepoxy
• libdrm
• libpipewire

build dependencies(for debian):

• g++
• libegl-dev
• libepoxy-dev
• libdrm-dev
• cmake
• extra-cmake-modules
• qt6-declarative-dev
• qt6-declarative-private-dev
• qt6-base-dev
• libpipewire-0.3-dev

Configuration

Running

ref example

How to Contribute

• Contributing just involves sending a merge request.
• Note: rules are made to be broken. Adjust or ignore any/all of these as you see fit, but be prepared to justify it to your peers.

Code Style

• When modifying existing code, the current code style should be respected.
• New code: the part should follow the code style of Qt (https://wiki.qt.io/Qt_Coding_Style this link is for reference only. The actual Qt source code shall prevail)
• There is no absolute right or wrong code style, please consider the big picture, and do not rigidly stick to the small details

Code Architecture Guidelines

• The code should be simple and easy to understand.
• Add comments to key nodes whether you change or add new code
• Security > Compatibility > Extensibility >= Performance

Contribution Guideline

• Contribution steps.
  1. First login to your Github/Gitee account and fork the project
  2. Pull the forked project locally using git clone.
  3. Push the new commit to your project using git push.
  4. commit your code to the upstream project on Github/Gitee using the Pull Requese feature.
• commit message specification: align with Qt project, use English. Be sure to describe exactly what the commit "does" and "why it was made"
• A commit only does one thing, and the smaller the code changes, the easier it is to accept the commit. For larger code changes, try to split the commit into multiple commits (satisfying the git commit principle as a prerequisite)
• Please do your own testing and code review before committing the code, and submit the PR after confirming that the code is working correctly

Roadmap

• Implement lychee design components for Qt QML(Inspired by fluent and macos)
• Support off-screen material dualkawaseblur processing
• Support Vulkan rendering API under QRhi framework
• Provides convenient controls for desktop components UI(dock、launcher、desktop、lychee-settings....)