aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRobert Tari <robert@tari.in>2021-08-23 00:51:45 +0200
committerRobert Tari <robert@tari.in>2021-08-23 00:51:45 +0200
commitdf7167ecea06cc760b5178a4ebd416e445adefdf (patch)
treebc961134a8b97a9cf5b3f0729d566bebcb9043c4 /README.md
parent600349dd2fb146e8de3c98581d100d3c9bb8ea45 (diff)
downloadayatana-indicator-sound-df7167ecea06cc760b5178a4ebd416e445adefdf.tar.gz
ayatana-indicator-sound-df7167ecea06cc760b5178a4ebd416e445adefdf.tar.bz2
ayatana-indicator-sound-df7167ecea06cc760b5178a4ebd416e445adefdf.zip
Add info and build instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md49
1 files changed, 49 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1072c28
--- /dev/null
+++ b/README.md
@@ -0,0 +1,49 @@
+# Ayatana System Indicator &mdash; Sound [![Build Status](https://travis-ci.com/AyatanaIndicators/ayatana-indicator-sound.svg)](https://travis-ci.com/AyatanaIndicators/ayatana-indicator-sound)
+
+## 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 Sound Ayatana System Indicator
+
+The -sound Ayatana System Indicator is the sound 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/AyatanaIndicatorSound
+
+## 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.