From 1970e45c92496fd4232d0c2dcaf54401a5a2ccc9 Mon Sep 17 00:00:00 2001
From: Ken Dreyer <ktdreyer@ktdreyer.com>
Date: Dec 08 2011 21:05:02 +0000
Subject: add some clues to README


Mash can always use more documentation. Here's an initial stab at it.

---

diff --git a/README b/README
index 20bba09..0b8b76a 100644
--- a/README
+++ b/README
@@ -1,3 +1,15 @@
 
 mash is a tool that creates repositories from koji tags, and solves
 them for multilib dependencies.
+
+Mash takes a .mash settings file and generates a yum repository.
+
+For example:
+$ mash --output /mnt/repo/ f15
+
+This tells mash to generate the repository to /mnt/repo, and to use
+the configuration file "f15.mash".
+
+Mash's main configuration is at /etc/mash. The main mash.conf file
+contains basic settings for using mash. The other configurations end
+in ".mash".