No description
leyoda
8701aa31d8
Part of the yoda fork direction: libcosmic-yoda is Wayland-only going forward. Cargo.toml changes: - default features: remove winit, x11, iced-wayland, multi-window -> add wayland - applet feature: remove winit dep - merge iced-wayland into wayland (simpler feature graph) - remove winit, winit_debug, winit_tokio, winit_wgpu, x11, iced-wayland features - keep iced_winit dep (it's a misnomer — also hosts the wayland/cctk runtime) Workspace: - examples/* excluded (many depend on winit/x11) — revisited in a later phase Behavior: - Library builds clean in release with default features (cargo check + cargo build --release --lib OK) - 58 lines in src/ gated on feature "winit" become unreachable (dead-code warnings — cleanup deferred) - 108 lines gated on feature "wayland" now always active via default --all-features is known-broken because tokio/async-std/smol are mutually exclusive — this is pre-existing, not a Phase 2 regression. |
||
|---|---|---|
| .github | ||
| .vscode | ||
| cosmic-config | ||
| cosmic-config-derive | ||
| cosmic-icons@5252095787 | ||
| cosmic-theme | ||
| examples | ||
| i18n | ||
| iced@78caabba7e | ||
| res | ||
| src | ||
| .gitignore | ||
| .gitmodules | ||
| build.rs | ||
| Cargo.toml | ||
| config.toml | ||
| i18n.toml | ||
| justfile | ||
| LICENSE | ||
| README.md | ||
LIBCOSMIC
A platform toolkit based on iced for creating applets and applications for the COSMIC™ desktop.
Documentation
- API Documentation: Automatically generated from this repository via
cargo doc - libcosmic Book: A reference for learning libcosmic
Templates
- https://github.com/pop-os/cosmic-app-template: Application project template
- https://github.com/pop-os/cosmic-applet-template: Panel applet project template
Dependencies
While libcosmic is written entirely in Rust, some of its dependencies may require shared system library headers to be installed. On Pop!_OS, the following dependencies are all that's necessary to compile a typical COSMIC project:
sudo apt install cargo cmake just libexpat1-dev libfontconfig-dev libfreetype-dev libxkbcommon-dev pkgconf
Examples
Some examples are included in the examples directory to to kickstart your COSMIC adventure. To run them, you need to clone the repository with the following commands:
git clone --recurse-submodules https://github.com/pop-os/libcosmic
cd libcosmic
If you have already cloned the repository, run these to sync with the latest updates:
git fetch origin
git checkout master
git reset --hard origin/master
The examples may then be run by their cargo project names, such as just run application.
Cargo Features
Available cargo features to choose from:
a11y: Experimental accessibility support.animated-image: Enables animated images from the image crate.debug: Enables addtional debugging features.smol: Uses smol as the preferred async runtime.- Conflicts with
tokio
- Conflicts with
tokio: Uses tokio as the preferred async runtime.- If unset, the default executor defined by iced will be used.
- Conflicts with
smol
wayland: Wayland-compatible client windows.- Conflicts with
winit
- Conflicts with
winit: Cross-platform and X11 client window support- Conflicts with
wayland
- Conflicts with
wgpu: GPU accelerated rendering with WGPU.- By default, softbuffer is used for software rendering.
xdg-portal: Enables XDG portal dialog integrations.
Project Showcase
- COSMIC App Library
- COSMIC Applets
- COSMIC Launcher
- COSMIC Notifications
- COSMIC Panel
- COSMIC Text Editor
- COSMIC Settings
Licence
Licensed under the Mozilla Public License 2.0.