summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorjvoisin2018-05-14 22:59:42 +0200
committerjvoisin2018-05-14 22:59:42 +0200
commit6e8f9e578a9d173cdd79729e61c1ec852f0086b6 (patch)
treeb32f759bcf25040078403d5c3e60b5a26022deb3 /README.md
parent289f2b96417a0ad768be19bdc1113006bdd5f5ea (diff)
Improve a bit the readme0.1.0
Diffstat (limited to 'README.md')
-rw-r--r--README.md49
1 files changed, 49 insertions, 0 deletions
diff --git a/README.md b/README.md
index 53a1c71..51f3c63 100644
--- a/README.md
+++ b/README.md
@@ -12,6 +12,21 @@
12This software is currently in **beta**, please don't use it for anything 12This software is currently in **beta**, please don't use it for anything
13critical. 13critical.
14 14
15# Metadata and privacy
16
17Metadata consist of information that characterizes data.
18Metadata are used to provide documentation for data products.
19In essence, metadata answer who, what, when, where, why, and how about
20every facet of the data that are being documented.
21
22Metadata within a file can tell a lot about you.
23Cameras record data about when a picture was taken and what
24camera was used. Office documents like PDF or Office automatically adds
25author and company information to documents and spreadsheets.
26Maybe you don't want to disclose those information on the web.
27
28This is precisely the job of MAT2: getting rid, as much as possible, of
29metadata.
15 30
16# Requirements 31# Requirements
17 32
@@ -29,6 +44,12 @@ doesn't run on [Debian Jessie](Stretc://packages.debian.org/jessie/python3),
29$ python3 -m unittest discover -v 44$ python3 -m unittest discover -v
30``` 45```
31 46
47# Supported formats
48
49```bash
50$ python3 ./main.py -l
51```
52
32# Related softwares 53# Related softwares
33 54
34- The first iteration of [MAT](http://mat.boum.org) 55- The first iteration of [MAT](http://mat.boum.org)
@@ -37,3 +58,31 @@ $ python3 -m unittest discover -v
37 tries to deal with *printer dots* too. 58 tries to deal with *printer dots* too.
38- [pdfparanoia](https://github.com/kanzure/pdfparanoia), that removes 59- [pdfparanoia](https://github.com/kanzure/pdfparanoia), that removes
39 watermarks from PDF. 60 watermarks from PDF.
61
62# License
63
64This program is free software: you can redistribute it and/or modify
65it under the terms of the GNU Lesser General Public License as published by
66the Free Software Foundation, either version 3 of the License, or
67(at your option) any later version.
68
69This program is distributed in the hope that it will be useful,
70but WITHOUT ANY WARRANTY; without even the implied warranty of
71MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
72GNU General Public License for more details.
73
74You should have received a copy of the GNU Lesser General Public License
75along with this program. If not, see <http://www.gnu.org/licenses/>.
76
77Copyright 2018 Julien (jvoisin) Voisin <julien.voisin+mat2@dustri.org>
78
79# Thanks
80
81MAT2 wouldn't existe without:
82
83- the Google Summer of Code,
84- the fine people from the Tails project
85- friends
86
87Many thanks to them!
88