summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorjvoisin2011-08-04 01:57:29 +0200
committerjvoisin2011-08-04 01:57:29 +0200
commitb87d10175eac8485c9f8b00cfc627085b880e589 (patch)
tree974e8564763e0bcd38b136d1782cd1fef64ec885 /README
parenta3b66f29742fba71b103dc58ec4624d52362452b (diff)
Complete the README
Diffstat (limited to 'README')
-rw-r--r--README54
1 files changed, 44 insertions, 10 deletions
diff --git a/README b/README
index db91636..9577afd 100644
--- a/README
+++ b/README
@@ -1,4 +1,4 @@
1Warning : 1WARNING :
2 Mat only remove metadata from your files, it does not anonymise their 2 Mat only remove metadata from your files, it does not anonymise their
3 content, nor it can handle watermarking, steganography, or any too custom 3 content, nor it can handle watermarking, steganography, or any too custom
4 metadata field/system. 4 metadata field/system.
@@ -6,21 +6,55 @@ Warning :
6 If you really want to be anonym, use format that does not contain any 6 If you really want to be anonym, use format that does not contain any
7 metadata, or better : use plain-text. 7 metadata, or better : use plain-text.
8 8
9Dependencies:
10 python2.7 : for tar, tar.bz2, tar.gz support
11 shred : for secure removal
12 9
13Optionals dependencies: 10DEPENDENCIES:
14 python-poppler, python-poppler : for pdf support 11 python2.6 (at least)
12 python-hachoir-core and python-hachoir-parser
13 shred (should be already installed)
14
15
16OPTIONALS DEPENDENCIES:
17 python-poppler and python-poppler : for pdf support
15 python-mutagen : for massive audio format support 18 python-mutagen : for massive audio format support
16 19
17Usage: 20
21USAGE:
18 python cli.py --help 22 python cli.py --help
19 or 23 or
20 python gui.py 24 python gui.py
21 25
22Supported format:
23 see lib/mat.py
24 26
25Known Bugs: 27SUPPORTED FORMAT:
28 python cli -l
29 or
30 python gui.py -> help -> supported formats
31
32
33LICENSE:
34 This program is free software; you can redistribute it and/or modify
35 it under the terms of the GNU General Public License version 2 as
36 published by the Free Software Foundation.
37
38 This program is distributed in the hope that it will be useful,
39 but WITHOUT ANY WARRANTY; without even the implied warranty of
40 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
41 GNU General Public License for more details.
42
43 You should have received a copy of the GNU General Public License
44 along with this program; if not, write to the Free Software
45 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
46 MA 02110-1301, USA.
47
48
49THANKS:
50 Mat would not exist without :
51 - the Google SUmmer of Code,
52 - the Python language
53 - the amazing (and messy) hachoir library,
54 - poppler and cairo's python bindings,
55 - and the mutagen library
56 many thanks to them !
57
58
59KNOWN BUGS:
26 Zipfiles are not totally cleaned 60 Zipfiles are not totally cleaned