aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRobert Tari <robert@tari.in>2021-06-04 17:39:18 +0200
committerRobert Tari <robert@tari.in>2021-06-04 17:39:18 +0200
commit9abc758821b848266f268b55376b220fb09fe2f2 (patch)
treedd9c85802522e639b427bceb36569b0b12909546 /README.md
parent6bac351ab94ae00a27b10a64c7a6a0fcc5e44a49 (diff)
downloadayatana-indicator-application-9abc758821b848266f268b55376b220fb09fe2f2.tar.gz
ayatana-indicator-application-9abc758821b848266f268b55376b220fb09fe2f2.tar.bz2
ayatana-indicator-application-9abc758821b848266f268b55376b220fb09fe2f2.zip
Add documentation and install instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md50
1 files changed, 50 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e5d278c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,50 @@
+# ayatana-indicator-application - Ayatana Indicator Application Service [![Build Status](https://travis-ci.com/AyatanaIndicators/ayatana-indicator-application.svg)](https://travis-ci.com/AyatanaIndicators/ayatana-indicator-application)
+
+## 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
+
+## About this Software Component
+
+The -application Ayatana System Indicator is an application menu indicator
+for Unity7, MATE and Lomiri (optionally for others, e.g. XFCE, LXDE). The
+indicator takes menus from applications and places them into the panel.
+
+Its behavior and features are listed at
+https://wiki.ayatana-indicators.org/AyatanaIndicatorApplication
+
+## 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.