summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFlorian Müllner <fmuellner@gnome.org>2018-05-23 17:55:43 +0200
committerFlorian Müllner <fmuellner@gnome.org>2018-05-23 19:03:01 +0200
commit02bbf409eadd55cf025646567fc898d60c90c0d3 (patch)
tree9000bf6d23848ddc555560ed813c8a4c1232f57b /README.md
parentf56e4e177e3bf98d0247098409b9c4918aa47555 (diff)
downloadgnome-shell-02bbf409eadd55cf025646567fc898d60c90c0d3.tar.gz
docs: Use Markdown
Markdown produces nicer output where supported, so use that instead of plain ASCII formatting.
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..6bec164c4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# GNOME Shell
+GNOME Shell provides core user interface functions for the GNOME 3 desktop,
+like switching to windows and launching applications. GNOME Shell takes
+advantage of the capabilities of modern graphics hardware and introduces
+innovative user interface concepts to provide a visually attractive and
+easy to use experience.
+
+For more information about GNOME Shell, including instructions on how
+to build GNOME Shell from source and how to get involved with the project,
+see the [project wiki][wiki]
+
+Bugs should be reported to the GNOME [bug tracking system][bug-tracker].
+
+## License
+GNOME Shell is distributed under the terms of the GNU General Public License,
+version 2 or later. See the [COPYING][license] file for details.
+
+[project-wiki]: https://wiki.gnome.org/Projects/GnomeShell
+[bug-tracker]: https://gitlab.gnome.org/GNOME/gnome-shell/issues
+[license]: COPYING