summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorjvoisin2011-12-25 18:22:50 +0100
committerjvoisin2011-12-25 18:22:50 +0100
commit6c64102d7e5185374e581b170d0a10ca77746d1e (patch)
tree8ce3089181b977a24a087cc9f0136b56417dd414 /README
parenta4f271f55c0739224bd32818432a59bf08b16288 (diff)
Update documentation
Diffstat (limited to '')
-rw-r--r--README11
1 files changed, 9 insertions, 2 deletions
diff --git a/README b/README
index 3943ff2..e3cce0d 100644
--- a/README
+++ b/README
@@ -4,6 +4,7 @@ METADATA:
4 In essence, metadata answer who, what, when, where, why, and how about 4 In essence, metadata answer who, what, when, where, why, and how about
5 every facet of the data that are being documented. 5 every facet of the data that are being documented.
6 6
7
7METADATA AND PRIVACY: 8METADATA AND PRIVACY:
8 Metadata within a file can tell a lot about you. 9 Metadata within a file can tell a lot about you.
9 Cameras record data about when a picture was taken and what 10 Cameras record data about when a picture was taken and what
@@ -11,6 +12,7 @@ METADATA AND PRIVACY:
11 author and company information to documents and spreadsheets. 12 author and company information to documents and spreadsheets.
12 Maybe you don't want to disclose those information on the web. 13 Maybe you don't want to disclose those information on the web.
13 14
15
14WARNING : 16WARNING :
15 Mat only removes metadata from your files, it does not anonymise their 17 Mat only removes metadata from your files, it does not anonymise their
16 content, nor can it handle watermarking, steganography, or any too custom 18 content, nor can it handle watermarking, steganography, or any too custom
@@ -128,10 +130,13 @@ HOW TO IMPLEMENT NEW FORMATS:
128 - get_meta(self) 130 - get_meta(self)
129 5. don't forget to call the do_backup() method when necessary 131 5. don't forget to call the do_backup() method when necessary
130 132
133
131HOW TO LAUNCH THE TESTSUITE: 134HOW TO LAUNCH THE TESTSUITE:
132 1. cd ./test 135 1. cd ./test
133 2. python2.6 clitest.py : launch the testsuite for the CLI 136 2. python2.6 test.py : launch all testsuites
134 3. python2.6 libtest.py : launch the testsuite for the mat internal library 137 3. python2.6 clitest.py : launch the testsuite for the CLI
138 4. python2.6 libtest.py : launch the testsuite for the mat internal library
139
135 140
136ALTERNATIVES AND COMPLEMENTS: 141ALTERNATIVES AND COMPLEMENTS:
137for images: 142for images:
@@ -150,6 +155,7 @@ NOTES:
150 Formats that are not in the test suite are not well-tested, 155 Formats that are not in the test suite are not well-tested,
151 please don't trust the MAT about them ! 156 please don't trust the MAT about them !
152 157
158
153LICENSE: 159LICENSE:
154 This program is free software; you can redistribute it and/or modify 160 This program is free software; you can redistribute it and/or modify
155 it under the terms of the GNU General Public License version 2 as 161 it under the terms of the GNU General Public License version 2 as
@@ -173,6 +179,7 @@ THANKS:
173 - the amazing (and messy) hachoir library, 179 - the amazing (and messy) hachoir library,
174 - poppler and cairo's python bindings, 180 - poppler and cairo's python bindings,
175 - and the mutagen library 181 - and the mutagen library
182 - people on #tails@freenode
176 many thanks to them ! 183 many thanks to them !
177 184
178 185