diff options
author | Doomsdayrs <doomsdayrs@gmail.com> | 2022-05-10 21:09:50 +0000 |
---|---|---|
committer | Doomsdayrs <doomsdayrs@gmail.com> | 2022-05-10 21:09:50 +0000 |
commit | 4f1974f19eeacba4824cf3fd2da3d10751203918 (patch) | |
tree | 5d57562e62f6738eecd7e34787730bbff0691a42 /README.md | |
parent | dfa2d6ea142c73c20024cc3a3cefdaa4706268af (diff) | |
download | yelp-tools-4f1974f19eeacba4824cf3fd2da3d10751203918.tar.gz |
Convert README to MD
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..2cd0930 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# 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/` + The templates directory contains page templates used by yelp-new. + +- `tools/` + The tools directory contains scripts like yelp-build and yelp-check, + as well as the yelp.m4 file that provides autotools integration. + +- `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. |