add README for CPAN

3 files changed, 16 insertions, 0 deletions

diff --git a/MANIFEST b/MANIFEST
index 179574f..6eba389 100644
--- a/MANIFEST
+++ b/MANIFEST
@@ -10,3 +10,4 @@ packdrake
 packdrake.pm
 t/01packdrake.t
 META.yml                                 Module meta-data (added by MakeMaker)
+README
diff --git a/NEWS b/NEWS
index 3fd48f9..410d241 100644
--- a/NEWS
+++ b/NEWS
@@ -1,3 +1,5 @@
+- CPAN: add README
+
 Version 7.03 - 19 September 2018, by Thierry Vignaud
 
 - cpan_testers: list deps
diff --git a/README b/README
new file mode 100644
index 0000000..a86c764
--- /dev/null
+++ b/README
@@ -0,0 +1,13 @@
+The packdrake module allows you to manipulate hdlist/synthesis files
+It is a compatibility wrapper around the new MDV::Packdrakeng module.
+
+genhdlist2 is used to generate an hdlist and an associated synthesis file for
+one repository (medium in urpmi language).
+A medium is from a set of RPM packages found in the directory.
+It will put the hdlist and synthesis files in media_info/ sub-directory.
+
+gendistrib is a wrapper above genhdlist2, it works on all media at once, in
+order to generate a mirror tree for a distribution
+
+This library is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.