Merge branch 'tari01-pr/add-info-and-install-instructions'

Attributes GH PR #28: https://github.com/AyatanaIndicators/ayatana-indicator-display/pull/28

2 files changed, 101 insertions, 0 deletions

diff --git a/INSTALL.md b/INSTALL.md
new file mode 100644
index 0000000..b522ea3
--- /dev/null
+++ b/INSTALL.md
@@ -0,0 +1,53 @@
+# Build and installation instructions
+
+## Compile-time build dependencies
+
+ - cmake (>= 3.13)
+ - cmake-extras
+ - intltool
+ - libayatana-common (>=0.9.3)
+ - glib-2.0 (>= 2.36)
+ - gudev-1.0
+ - gtest (>= 1.6.0) - **For testing**
+ - qt5-base5 - **For testing**
+ - libqtdbusmock1 - **For testing**
+ - libqtdbustest1 - **For testing**
+ - cppcheck - **For testing**
+ - gcovr (>= 2.4) - **For coverage**
+ - lcov (>= 1.9) - **For coverage**
+
+## For end-users and packagers
+
+```
+cd ayatana-indicator-display-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-display-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-display-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..4ac300e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+# Ayatana System Indicator — Display [![Build Status](https://travis-ci.com/AyatanaIndicators/ayatana-indicator-display.svg)](https://travis-ci.com/AyatanaIndicators/ayatana-indicator-display)
+
+## 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 Display Ayatana System Indicator
+
+The -display Ayatana System Indicator is the display menu indicator for
+Lomiri (Currently rotation-lock only, but we are planning to add further
+functionality for desktops, e.g. MATE, XFCE, LXDE). Its behavior and features will be listed at
+https://wiki.ayatana-indicators.org/AyatanaIndicatorDisplay
+
+## 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.