1 files changed, 34 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c776bb5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+FIDD (Format ISO Download Data)
+===============================
+
+Helper script to:
+
+- fetch built ISOs info (names, checksums, sizes, langs, etc.)
+- build a catalog (in var/definitions) that can be used for the Web
+  site download redirector (see http://www.mageia.org/downloads/ section,
+  source code in svn/web/www).
+
+## Usage
+
+First, edit extract.php and update $prefix, $bcd_path and $bcd_url.
+
+Then:
+
+    $ make clean
+    $ make catalog
+
+Finally, get your copy from var/definitions/data.{ini,json,yaml}.
+
+## Code
+
+### Licensed under MIT license (see LICENSE.txt)
+
+### Authors
+
+- Romain d'Alverny (rda at mageia.org)
+
+### Feedback, patches
+
+- #mageia-web on Freenode IRC
+- https://www.mageia.org/mailman/listinfo/mageia-webteam
+- or to authors
+\ No newline at end of file