diff options
| author | Robert Tari <robert@tari.in> | 2021-07-28 23:08:45 +0200 |
|---|---|---|
| committer | Mike Gabriel <mike.gabriel@das-netzwerkteam.de> | 2021-08-04 16:02:10 +0200 |
| commit | c200a3d1cf5a6fab281274aa559c0119ca70bee4 (patch) | |
| tree | 34427e8d32328ebc7a71fd8478bf7a11c6096067 | |
| parent | cbfecc6afcc9976506925ec124364aaa99a03f8f (diff) | |
| download | ayatana-indicator-bluetooth-c200a3d1cf5a6fab281274aa559c0119ca70bee4.tar.gz ayatana-indicator-bluetooth-c200a3d1cf5a6fab281274aa559c0119ca70bee4.tar.bz2 ayatana-indicator-bluetooth-c200a3d1cf5a6fab281274aa559c0119ca70bee4.zip | |
Add documentation and build instructions
| -rw-r--r-- | INSTALL.md | 49 | ||||
| -rw-r--r-- | README.md | 49 |
2 files changed, 98 insertions, 0 deletions
diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..9cef72a --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,49 @@ +# Build and installation instructions + +## Compile-time build dependencies + + - cmake (>= 3.13) + - cmake-extras + - glib-2.0 (>= 2.36) + - intltool + - systemd + - vala (>= 0.20) + - gcovr (>= 2.4) + - lcov (>= 1.9) + - gtest (>= 1.6.0) + +## For end-users and packagers + +``` +cd ayatana-indicator-bluetooth-X.Y.Z +mkdir build +cd build +cmake .. +make +sudo make install +``` + +**The install prefix defaults to `/usr`, change it with `-DCMAKE_INSTALL_PREFIX=/some/path`** + +## For testers - unit tests only + +``` +cd ayatana-indicator-bluetooth-X.Y.Z +mkdir build +cd build +cmake .. -DENABLE_TESTS=ON +make +make test +make cppcheck +``` + +## For testers - both unit tests and code coverage + +``` +cd ayatana-indicator-bluetooth-X.Y.Z +mkdir build-coverage +cd build-coverage +cmake .. -DENABLE_COVERAGE=ON +make +make coverage-html +``` diff --git a/README.md b/README.md new file mode 100644 index 0000000..ef122da --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +# Ayatana System Indicator — Bluetooth [](https://travis-ci.com/AyatanaIndicators/ayatana-indicator-bluetooth) + +## 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 Bluetooth Ayatana System Indicator + +The -bluetooth Ayatana System Indicator is the bluetooth 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/AyatanaIndicatorBluetooth + +## 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. |