summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..a249e51c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# Yelp
+The default help viewer for the GNOME desktop. Yelp provides
+a simple graphical interface for viewing Mallard, DocBook, HTML, man,
+and info formatted documentation. The name Yelp was suggested by Daniel
+Lundin. Yelp is pronounced the same as the swedish word for 'help'.
+
+The Yelp help viewer builds on yelp-xsl and yelp-tools. You can use
+these to build and manage your documentation. For more information:
+
+ http://yelp.io/
+
+Yelp is developed in GNOME git, and mirrored to GitHub. Please do all
+development in GNOME:
+
+ https://gitlab.gnome.org/GNOME/yelp/
+
+Bugs are tracking in the GNOME issue tracker, product yelp:
+
+ https://gitlab.gnome.org/GNOME/yelp/-/issues/
+
+Yelp is distributed under the GNU General Public License, version 2
+or later. See the COPYING file for details.