From de47a96f104bcbab3c798ce1393d2b5eea5fde82 Mon Sep 17 00:00:00 2001 From: Robert Tari Date: Wed, 28 Jul 2021 19:10:23 +0200 Subject: Add documentation and build instructions --- README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..0f0b74e --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +# Ayatana System Indicator — Power [![Build Status](https://travis-ci.com/AyatanaIndicators/ayatana-indicator-power.svg)](https://travis-ci.com/AyatanaIndicators/ayatana-indicator-power) + +## About Ayatana Indicators + +The Ayatana Indicators project is the continuation of Application +Indicators and System Indicators, two technologies developed by Canonical +Ltd. for the Unity7 desktop. + +Application Indicators are a GTK implementation of the StatusNotifierItem +Specification (SNI) that was originally submitted to freedesktop.org by +KDE. + +System Indicators are an extensions to the Application Indicators idea. +System Indicators allow for far more widgets to be displayed in the +indicator's menu. + +The Ayatana Indicators project is the new upstream for application +indicators, system indicators and associated projects with a focus on +making Ayatana Indicators a desktop agnostic technology. + +On GNU/Linux, Ayatana Indicators are currently available for desktop +envinronments like MATE (used by default in [Ubuntu +MATE](https://ubuntu-mate.com)), XFCE (used by default in +[Xubuntu](https://bluesabre.org/2021/02/25/xubuntu-21-04-progress-update/), +LXDE, and the Budgie Desktop). + +The Lomiri Operating Environment (UI of the Ubuntu Touch OS, formerly +known as Unity8) uses Ayatana Indicators for rendering its notification +area and the [UBports](https://ubports.com) project is a core contributor +to the Ayatana Indicators project. + +For further info, please visit: +https://ayatana-indicators.org + + +## The Power Ayatana System Indicator + +The -power Ayatana System Indicator is the power menu indicator for +Unity7, MATE and Lomiri (optionally for others, e.g. XFCE, LXDE). Its +behavior and features are listed at +https://wiki.ayatana-indicators.org/AyatanaIndicatorPower + +## License and Copyright + +See COPYING and AUTHORS file in this project. + +## Building and Testing + +For instructions on building and running built-in tests, see the INSTALL.md file. -- cgit v1.2.3