Skip to content

Latest commit

 

History

History
48 lines (33 loc) · 1.85 KB

README.md

File metadata and controls

48 lines (33 loc) · 1.85 KB
Raw

COSMIC App/Applet Template

A cargo-generate template for developing applications and applets for the COSMIC™ desktop environment.

Getting Started

# Install cargo-generate
cargo install cargo-generate
# Create your project using this template
cargo generate --git https://github.com/D-Brox/cosmic-generate-template

A justfile is included by default with common recipes used by other COSMIC projects. Install from casey/just.

  • just builds the application with the default just build-release recipe
  • just run builds and runs the application
  • just install installs the project into the system
  • just vendor creates a vendored tarball
  • just build-vendored compiles with vendored dependencies from that tarball
  • just check runs clippy on the project to check for linter warnings
  • just check-json can be used by IDEs that support LSP

A second justfile is also included with packaging recipes:

  • deb: run just build-deb and sudo just install-deb
  • rpm: run just build-rpm and sudo just install-rpm
  • aur: run just build-aur and sudo just install-aur
  • flatpak: run just install-flatpak (requires flatpak-builder)

Documentation

Refer to the libcosmic API documentation and book for help with building applications with libcosmic.

Thanks

This template is based on: