From 6bf9165df5e22792b7470d7946077d85533412fc Mon Sep 17 00:00:00 2001
From: Robert Tari <robert@tari.in>
Date: Thu, 29 Jul 2021 01:05:09 +0200
Subject: Add documentation and build instructions

---
 INSTALL.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++
 README.md  | 55 +++++++++++++++++++++++++++++++++++++++++++++++++------
 2 files changed, 100 insertions(+), 6 deletions(-)
 create mode 100644 INSTALL.md

diff --git a/INSTALL.md b/INSTALL.md
new file mode 100644
index 00000000..bf2200a4
--- /dev/null
+++ b/INSTALL.md
@@ -0,0 +1,51 @@
+# Build and installation instructions
+
+## Compile-time build dependencies
+
+ - cmake (>= 3.13)
+ - cmake-extras
+ - glib-2.0 (>= 2.36)
+ - gio-2.0 (>=2.36)
+ - x11 (>=1.6.7)
+ - libxklavier (>=5.4)
+ - intltool
+ - systemd
+ - gcovr (>= 2.4)
+ - lcov (>= 1.9)
+ - gtest (>= 1.6.0)
+
+## For end-users and packagers
+
+```
+cd ayatana-indicator-keyboard-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-keyboard-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-keyboard-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
index 53332920..51e13bad 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,53 @@
-# Ayatana Keyboard Indicator
+# Ayatana System Indicator &mdash; Keyboard [![Build Status](https://travis-ci.com/AyatanaIndicators/ayatana-indicator-keyboard.svg)](https://travis-ci.com/AyatanaIndicators/ayatana-indicator-keyboard)
 
-### Themed icons
+## About Ayatana Indicators
 
-To generate icons for a theme, you can use the icon generator in the data
-directory. Run it with the -h switch for help on usage.
+The Ayatana Indicators project is the continuation of Application
+Indicators and System Indicators, two technologies developed by Canonical
+Ltd. for the Unity7 desktop.
 
-### TODO
+Application Indicators are a GTK implementation of the StatusNotifierItem
+Specification (SNI) that was originally submitted to freedesktop.org by
+KDE.
 
-- Drop utils and use libayatana-common
+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 Keyboard Ayatana System Indicator
+
+The -keyboard Ayatana System Indicator is the keyboard 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/AyatanaIndicatorKeyboard
+
+## Themed icons
+
+To generate icons for a theme, you can use the icon generator in the data directory. Run it with the -h switch for help on usage.
+
+## 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.
-- 
cgit v1.2.3