https://github.com/elementary/shortcut-overlay

A native, OS-wide shortcut overlay
https://github.com/elementary/shortcut-overlay

gtk gtk3 hacktoberfest meson vala

Last synced: about 2 months ago
JSON representation

A native, OS-wide shortcut overlay

• Host: GitHub
• URL: https://github.com/elementary/shortcut-overlay
• Owner: elementary
• License: gpl-3.0
• Created: 2017-11-02T15:55:43.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T12:52:49.000Z (about 2 months ago)
• Last Synced: 2024-10-29T15:20:12.463Z (about 2 months ago)
• Topics: gtk, gtk3, hacktoberfest, meson, vala
• Language: Vala
• Homepage: https://elementary.io
• Size: 3.41 MB
• Stars: 33
• Watchers: 26
• Forks: 8
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred-test - elementary/shortcut-overlay - A native, OS-wide shortcut overlay (Vala)

README

        
# Shortcut Overlay

[![Translation status](https://l10n.elementary.io/widgets/desktop/-/shortcut-overlay/svg-badge.svg)](https://l10n.elementary.io/engage/desktop/?utm_source=widget)

A native OS-wide shortcut overlay to be launched by Gala.

This GTK+ applet reads window manager and OS keyboard shortcuts from dconf

and exposes them to the user when launched. Inspired by the similar [feature][1]

of Ubuntu Unity introduced in Ubuntu 12.04.

![Screenshot](/data/[email protected])

The shortcut window opens centered on the primary display. The gear in the titlebar opens the [system keyboard settings](settings://input/keyboard/shortcuts).

## Included Shortcuts

We need to decide which shortcuts are included, how they're sorted, and if they're grouped into smaller categories. [Read this document](https://paper.dropbox.com/doc/elementary-OS-Shortcut-Overlay-z3oP5UefS11B2OpOZpKE5?_tk=share_copylink) to that effect.

## Building, Testing, and Installation

You'll need the following dependencies:

* libgee-0.8-dev

* libgranite-7-dev

* libgtk-4-dev

* meson

* valac

Run `meson build` to configure the build environment and then change to the build directory and run `ninja` to build

    meson build --prefix=/usr

    cd build

    ninja

To install, use `ninja install`, then execute with `io.elementary.shortcut-overlay`

    sudo ninja install

    io.elementary.shortcut-overlay

[1]: https://bugs.launchpad.net/ayatana-design/+bug/855532