diff options
| author | jvoisin | 2018-05-14 22:59:42 +0200 |
|---|---|---|
| committer | jvoisin | 2018-05-14 22:59:42 +0200 |
| commit | 6e8f9e578a9d173cdd79729e61c1ec852f0086b6 (patch) | |
| tree | b32f759bcf25040078403d5c3e60b5a26022deb3 /README.md | |
| parent | 289f2b96417a0ad768be19bdc1113006bdd5f5ea (diff) | |
Improve a bit the readme0.1.0
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 49 |
1 files changed, 49 insertions, 0 deletions
| @@ -12,6 +12,21 @@ | |||
| 12 | This software is currently in **beta**, please don't use it for anything | 12 | This software is currently in **beta**, please don't use it for anything |
| 13 | critical. | 13 | critical. |
| 14 | 14 | ||
| 15 | # Metadata and privacy | ||
| 16 | |||
| 17 | Metadata consist of information that characterizes data. | ||
| 18 | Metadata are used to provide documentation for data products. | ||
| 19 | In essence, metadata answer who, what, when, where, why, and how about | ||
| 20 | every facet of the data that are being documented. | ||
| 21 | |||
| 22 | Metadata within a file can tell a lot about you. | ||
| 23 | Cameras record data about when a picture was taken and what | ||
| 24 | camera was used. Office documents like PDF or Office automatically adds | ||
| 25 | author and company information to documents and spreadsheets. | ||
| 26 | Maybe you don't want to disclose those information on the web. | ||
| 27 | |||
| 28 | This is precisely the job of MAT2: getting rid, as much as possible, of | ||
| 29 | metadata. | ||
| 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 | |||
| 64 | This program is free software: you can redistribute it and/or modify | ||
| 65 | it under the terms of the GNU Lesser General Public License as published by | ||
| 66 | the Free Software Foundation, either version 3 of the License, or | ||
| 67 | (at your option) any later version. | ||
| 68 | |||
| 69 | This program is distributed in the hope that it will be useful, | ||
| 70 | but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| 71 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| 72 | GNU General Public License for more details. | ||
| 73 | |||
| 74 | You should have received a copy of the GNU Lesser General Public License | ||
| 75 | along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| 76 | |||
| 77 | Copyright 2018 Julien (jvoisin) Voisin <julien.voisin+mat2@dustri.org> | ||
| 78 | |||
| 79 | # Thanks | ||
| 80 | |||
| 81 | MAT2 wouldn't existe without: | ||
| 82 | |||
| 83 | - the Google Summer of Code, | ||
| 84 | - the fine people from the Tails project | ||
| 85 | - friends | ||
| 86 | |||
| 87 | Many thanks to them! | ||
| 88 | |||
