waydeer/layer-shika
1
0
Fork 0
mirror of https://codeberg.org/waydeer/layer-shika.git synced 2025-12-23 13:35:56 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs(readme): update current library status on readme

Browse source
This commit is contained in:
drendog 2025-11-25 02:41:49 +01:00
parent 58278cecef
commit 198376534c
Signed by: dwenya
GPG key ID: 8DD77074645332D0
1 changed files with 31 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
README.md
View file

@ -10,21 +10,43 @@ Please note that this library is currently in early development and is not yet r
## Current Status ## Current Status
May be not updated: - **Architecture**: Clean hexagonal architecture with domain, adapters, and composition layers
- **Rendering**: EGL context management with `femtovg` renderer integration
- **Wayland**: Comprehensive layer shell protocol support using `smithay-client-toolkit`
- Output management and configuration
- Surface lifecycle management
- Basic xdg popup support (currently with double creation workaround, due dependencies limitations)
- Event handling system
- **UI Integration**: Slint integration layer with custom rendering backend
- **Documentation**: Work in progress
- **Examples**: Coming soon (examples directory prepared)
**What's Working:**
- EGL context creation and management
- Wayland layer shell surface creation
- XDG popup support (with some limitations, new window and resizing needed to work with current workaround)
- Basic rendering with femtovg
- Output detection and management
- Event handling framework
**Known Limitations:**
- 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 - Not all features are fully implemented or tested
- Documentation is incomplete or non-existent - API is still unstable and may change
- Examples are coming soon - Examples and comprehensive documentation pending
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. It's recommended to wait for a stable release before using this library in production projects. Development is trying to be as fast as a running skippy deer!
## Usage ## Usage
Examples and usage instructions are coming soon. Hoping that they will not be too deer-ifying, like the current state of this library. Examples and usage instructions are coming soon. Hoping that they will not be too deer-ifying, like the current state of this library. If you want to use it now, use this repo as dependency instead of crates.io outdated versions.
## First Stable Release
It aim to have the first stable release by the end of 2025, with a focus on core functionality and API stability.
Stay tuned!
## Contributing ## Contributing