A library to create desktop components for wayland using the layer shell and Slint GUI
Go to file
drendog c0eb63348d
chore: update repo link
2024-08-22 03:59:38 +02:00
examples chore: place folders 2024-08-22 01:56:18 +02:00
src chore: add missing must use on state builder 2024-08-21 13:50:49 +02:00
tests chore: place folders 2024-08-22 01:56:18 +02:00
.gitignore init commit 2024-08-13 22:30:13 +02:00
Cargo.lock feat: dismiss anyhow by replacing with thiserror 2024-08-21 12:44:53 +02:00
Cargo.toml chore: update repo link 2024-08-22 03:59:38 +02:00
LICENSE feat(license): migrate to AGPL 3.0 2024-08-21 16:50:34 +02:00
README.md fix: update links 2024-08-22 03:38:52 +02:00

README.md

layer-shika

Main repo | Mirror

⚠️ WORK IN PROGRESS ⚠️

Oh deer! 🦌 You've stumbled upon layer-shika, a rust library crate that provides a layer shell implementation for wayland compositors, using slint for the GUI. It allows you to create overlay windows and panels or bars that integrate seamlessly with wayland-based desktop environments.

Please note that this library is currently in early development and is not yet ready for production use.

Current Status

May be not updated:

  • The core functionality is under active development
  • femtovg renderer
  • Basic layer shell protocol support using smithay-client-toolkit, but this may change in future stable versions
  • Partial support for pointer events
  • Not all features are fully implemented or tested
  • Documentation is incomplete or non-existent
  • Examples are coming soon

It's recommended to wait for a stable release before using this library in any production projects. Development is trying to be as fast as a running skippy deer.

Usage

Examples and usage instructions are coming soon. Hoping that they will not be too deer-ifying, like the current state of this library.

Contributing

As the library is in a very early stage, it's recommended to open an issue to discuss ideas or proposed changes before submitting contributions. The project doesn't bite, it's not that kind of deer!