[yelp-tools: 1/2] Convert README to MD
- From: Shaun McCance <shaunm src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [yelp-tools: 1/2] Convert README to MD
- Date: Wed, 11 May 2022 16:41:51 +0000 (UTC)
commit 4f1974f19eeacba4824cf3fd2da3d10751203918
Author: Doomsdayrs <doomsdayrs gmail com>
Date: Tue May 10 21:09:50 2022 +0000
Convert README to MD
README => README.md | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
---
diff --git a/README b/README.md
similarity index 91%
rename from README
rename to README.md
index d4e44c39..2cd0930f 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.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]