[gnome-software] Rewrite README as it refers to out of date information



commit d686e2851881ae00b8349454e400bd454923e873
Author: Robert Ancell <robert ancell canonical com>
Date:   Wed Feb 14 13:32:35 2018 +1300

    Rewrite README as it refers to out of date information

 README      | 31 -------------------------------
 README.md   | 30 ++++++++++++++++++++++++++++++
 meson.build |  2 +-
 3 files changed, 31 insertions(+), 32 deletions(-)
---
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..cd963f7d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+[![Build 
Status](https://gitlab.gnome.org/GNOME/gnome-software/badges/master/build.svg)](https://gitlab.gnome.org/GNOME/gnome-software/pipelines)
+
+# Software
+
+[Software](https://wiki.gnome.org/Apps/Software) lets you install and update applications and system 
extensions.
+A plugin system is used to access software from different sources.
+Plugins are provided for:
+ - Traditional package installation via PackageKit (e.g. Debian package, RPM).
+ - Next generation packages: [Flatpak](https://flatpak.org/), [Snap](https://snapcraft.io/) and 
[Limba](https://people.freedesktop.org/~mak/limba/).
+ - Firmware updates.
+ - Ratings and reviews ([ODRS](https://odrs.gnome.org/) and Ubuntu reviews).
+ - [Steam](http://store.steampowered.com/) games.
+
+Software supports showing metadata that closely matches the 
[AppStream](https://www.freedesktop.org/wiki/Distributions/AppStream/) format.
+
+Software runs as a background service to provide update notifications and be a search provider for [GNOME 
Shell](https://wiki.gnome.org/Projects/GnomeShell).
+
+# Building
+
+Build locally with:
+```
+$ meson --prefix $PWD/install build/
+$ ninja -C build/ all install
+$ killall gnome-software
+$ XDG_DATA_DIRS=install/share:$XDG_DATA_DIRS ./install/bin/gnome-software
+```
+
+# Debugging
+
+Running with `--verbose` will give detailed logging information.
diff --git a/meson.build b/meson.build
index ac65d4bd..40b1e358 100644
--- a/meson.build
+++ b/meson.build
@@ -16,7 +16,7 @@ gs_plugin_api_version = '11'
 conf.set_quoted('GS_PLUGIN_API_VERSION', gs_plugin_api_version)
 
 # install docs
-install_data('README', install_dir : 'share/doc/gnome-software')
+install_data('README.md', install_dir : 'share/doc/gnome-software')
 
 # get suported warning flags
 test_args = [


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]