Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
33 lines (21 loc) · 1.17 KB

CONTRIBUTING.md

File metadata and controls

33 lines (21 loc) · 1.17 KB

Contributing

A brief overview over the project, its dependencies and build instructions.

Modules

Clapgrep consists of two modules:

  • core, which contains the search logic.
  • gnome, which is a Gtk + Adwaita frontend.

Requirements (for Fedora Rawhide toolbox)

These are required when building Clapgrep on Fedora Rawhide without Flatpak. This is only useful for development and the just check/build/test/run commands.

sudo dnf install just meson appstream cargo clippy gcc libglvnd-gles
sudo dnf install just gtk4-devel libadwaita-devel gtksourceview5-devel poppler-glib-devel

And you have to install blueprint-compiler which also requires python3-gobject.

Compilation and Development

  • Clapgrep requires up-to-date library versions (Fedora Rawhide or newest Gnome SDK)
  • The justfile provides convenient commands for compilation and development.
  • just ci can be used to run the CI locally.
  • You have to run just setup once to make rust-analyzer work.

Translations

You can help translate Clapgrep on Weblate .