diff options
| -rw-r--r-- | INSTALL.md | 62 | ||||
| -rw-r--r-- | README | 9 | ||||
| -rw-r--r-- | README.md | 51 |
3 files changed, 113 insertions, 9 deletions
diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..64921de --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,62 @@ +# Build and installation instructions + +## Compile-time build dependencies + + - cmake + - cmake-extras + - at-spi2-core + - gobject-introspection + - intltool + - gtk-doc + - libxml2 + - vala + - mono + - glib2 + - gtk3 + - gtk3-docs + - gtk-sharp-3 + - libayatana-indicator + - libdbusmenu-gtk3 + - libdbusmenu-glib + - libgirepository + - dbus-test-runner - **For testing** + - xorg-server-xvfb - **For testing** + - gcovr - **For coverage** + - lcov - **For coverage** + +## For end-users and packagers + +``` +cd libayatana-appindicator +mkdir build +cd build +cmake .. -DENABLE_GTKDOC=ON +make +sudo make install +``` + +**The install prefix defaults to `/usr`, change it with `-DCMAKE_INSTALL_PREFIX=/some/path`** +<br> +**The libexec prefix defaults to `/libexec`, change it with `-DCMAKE_INSTALL_LIBEXECDIR=lib`** + +## For testers - unit tests only + +``` +cd libayatana-appindicator +mkdir build +cd build +cmake .. -DENABLE_GTKDOC=ON -DENABLE_WERROR=ON -DENABLE_TESTS=ON +make +make test +``` + +## For testers - both unit tests and code coverage + +``` +cd libayatana-appindicator +mkdir build +cd build +cmake .. -DENABLE_GTKDOC=ON -DENABLE_WERROR=ON -DENABLE_COVERAGE=ON +make +make coverage +``` @@ -1,9 +0,0 @@ -# Ayatana Application Indicators (Shared Library) # - -A library to allow applications to export a menu into the an Application -Indicators aware menu bar. Based on KSNI it also works in KDE and will -fallback to generic Systray support if none of those are available. - -This code project was originally started by Canonical Ltd. and has been -adapted by various authors with the purpose of making this Application -Indicators available on Ubuntu and non-Ubuntu systems alike. diff --git a/README.md b/README.md new file mode 100644 index 0000000..7ed367e --- /dev/null +++ b/README.md @@ -0,0 +1,51 @@ +# Ayatana System Indicator — Display [](https://travis-ci.com/github/AyatanaIndicators/libayatana-appindicator) + +## 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 Ayatana Application Indicators (Shared Library) + +A library to allow applications to export a menu into the an Application +Indicators aware menu bar. Based on KSNI it also works in KDE and will +fallback to generic Systray support if none of those are available. + +This code project was originally started by Canonical Ltd. and has been +adapted by various authors with the purpose of making this Application +Indicators available on Ubuntu and non-Ubuntu systems alike. + +## 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. |