summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorShaun McCance <shaunm@gnome.org>2022-05-11 16:41:48 +0000
committerShaun McCance <shaunm@gnome.org>2022-05-11 16:41:48 +0000
commit73b668ead2b7e915568fd4517dc25cf2dcd9fe43 (patch)
tree5d57562e62f6738eecd7e34787730bbff0691a42
parentdfa2d6ea142c73c20024cc3a3cefdaa4706268af (diff)
parent4f1974f19eeacba4824cf3fd2da3d10751203918 (diff)
downloadyelp-tools-73b668ead2b7e915568fd4517dc25cf2dcd9fe43.tar.gz
Merge branch 'Doomsdayrs-master-patch-38452' into 'master'
Convert README to MD See merge request GNOME/yelp-tools!9
-rw-r--r--README.md (renamed from README)14
1 files changed, 7 insertions, 7 deletions
diff --git a/README b/README.md
index d4e44c3..2cd0930 100644
--- a/README
+++ b/README.md
@@ -1,21 +1,21 @@
-ABOUT
-=====
+# Yelp Tools
+
yelp-tools is a collection of scripts and build utilities to help create,
manage, and publish documentation for Yelp and the web. Most of the heavy
lifting is done by packages like yelp-xsl and itstool. This package just
wraps things up in a developer-friendly way.
-ORGANIZATION
-============
-templates/
+## ORGANIZATION
+
+- `templates/`
The templates directory contains page templates used by yelp-new.
-tools/
+- `tools/`
The tools directory contains scripts like yelp-build and yelp-check,
as well as the yelp.m4 file that provides autotools integration.
-xslt/
+- `xslt/`
The xslt directory contains small utility XSLT files that are used
by the various scripts shipped with yelp-tools. These stylesheets
are not intended to be built upon.