reformatting, adding doc

1 files changed, 42 insertions, 7 deletions

diff --git a/README.txt b/README.txt
index ffb36ec..103acc3 100644
--- a/README.txt
+++ b/README.txt
@@ -4,10 +4,39 @@ Mageia ISO check script
 Test suite for ISOs built for Mageia.
 All ISOs should pass this test suite after being built, before being released.
 
-License: GPL-2+
-Code:    svn://svn.mageia.org/svn/soft/isocheck
-         http://svnweb.mageia.org/soft/isocheck
-Doc:     https://wiki.mageia.org/en/Isocheck
+ - License: GPL-2+
+ - Authors:
+   - Damien Lallement <dams@mageia.org>
+   - Romain d'Alverny <rda@mageia.org>
+ - Code: [svn://svn.mageia.org/svn/soft/isocheck](http://svnweb.mageia.org/soft/isocheck)
+ - [Documentation](https://wiki.mageia.org/en/Isocheck)
+
+Usage
+-----
+
+    $ su
+    # perl ./test_iso.pl path/to/your/Mageia-x-i586.iso
+    ... logs ...
+
+Returns 0 in case of success (and last line of log starts with "PASS").
+
+Returns a positive integer otherwise (and last line of log starts with "FAIL").
+
+
+Features
+--------
+
+It tests for:
+
+ - availability of all components needed ((signed) checksums, indexes, lists),
+ - ISO file name correctness,
+ - file size according to its declaration,
+ - MD5 and SHA1 checksums,
+ - ISO headers correctness,
+ - burnable, hybrid ISO,
+ - depending on the type of image, it tests for the presence of autorun,
+   correctly signed packages and various bits.
+
 
 Requirements
 ------------
@@ -15,18 +44,24 @@ Requirements
 User running this script must be able to mount an ISO image.
 
 Depends on:
+
  - cdrkit, cdrkit-isotools
  - gpg
  - Perl
-   - Test::Most
+   - File::Basename
+   - MDK::Common
    - TAP::Harness
+   - TAP::Parser::Aggregator;
+   - Test::Most
 
 
 TODO
 ----
- - clean up
- - handle properly DVDs, CDs, LiveCDs
  - fix t_install_iso tests (ids, idx, rpms, pubkey - especially cauldron/stable)
+ - script should properly manage other types of ISOs:
+   * separate tests that are generic from those that are Mageia-specific
+   * move specific tests into t/{name}/*.t
+ - script should be run by a non-root user that can sudo mount
 
 
 Style