From 0bce1fdc13b64e04ba151c8428c94d7b3974d27d Mon Sep 17 00:00:00 2001
From: Robert Tari <robert@tari.in>
Date: Wed, 23 Jun 2021 01:13:56 +0200
Subject: Add install instructions + update documentation

- README.md: Update documentation
- INSTALL.md: Add file
- INSTALL: Drop old file
---
 README.md | 53 ++++++++++++++++++++++++++++++++++++++++++++++-------
 1 file changed, 46 insertions(+), 7 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 32564b7..ce7c403 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,43 @@
-# Ayatana Indicator DateTime
+# Ayatana System Indicator &mdash; DateTime [![Build Status](https://travis-ci.com/AyatanaIndicators/ayatana-indicator-datetime.svg)](https://travis-ci.com/AyatanaIndicators/ayatana-indicator-datetime)
 
-## INSTALLATION
+## 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
 
 When using the -datetime Ayatana Indicator, make sure that the -datetime
 Ubuntu Indicator (package name: indicator-datetime) is not installed.
 
-## ACTIONS
+## The Session Ayatana System Indicator
+
+### Actions
 
  * **desktop.open-settings-app**<br />
    **phone.open-settings-app**
@@ -56,7 +88,7 @@ Ubuntu Indicator (package name: indicator-datetime) is not installed.
                  and which day should have the cursor.
 
 
-## CUSTOM MENUITEMS
+### Custom Menuitems
 
  * Calendar
    - x-ayatana-type         s "org.ayatana.indicator.calendar"
@@ -82,9 +114,9 @@ Ubuntu Indicator (package name: indicator-datetime) is not installed.
 
 
 
-## CODE
+### Code
 
-### Model
+#### Model
 
   The app's model is represented by the "State" class, and "Menu" objects
   are the corresponding views. "State" is a simple container for various
@@ -115,7 +147,7 @@ Ubuntu Indicator (package name: indicator-datetime) is not installed.
   include/datetime/planner-eds.h<br />
   include/datetime/timezones-live.h<br />
 
-### View
+#### View
 
   Menu is a mostly-opaque class to wrap GMenu code. Its subclasses contain
   the per-profile logic of which sections/menuitems to show and which to hide.
@@ -133,3 +165,10 @@ Ubuntu Indicator (package name: indicator-datetime) is not installed.
   include/datetime/actions.h<br />
   include/datetime/exporter.h<br />
 
+## 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