doc: add README

main
Shiz 1 year ago
parent 920228e75b
commit 129a65612f
  1. 52
      README.md

@ -0,0 +1,52 @@
truedecrypt
===========
Decrypter for TrueCrypt 4.1-4.3 volumes.
Installing
----------
```sh
pip3 install -r requirements.txt
pip3 install .
```
Usage
-----
```
usage: truedecrypt [-h] [-k KEYFILE] [-p PASSWORD] infile [outfile]
positional arguments:
infile
outfile
optional arguments:
-h, --help show this help message and exit
-k KEYFILE, --keyfile KEYFILE
-p PASSWORD, --password PASSWORD
```
Limitations
-----------
Many.
License
-------
```
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
Version 2, December 2004
Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
Everyone is permitted to copy and distribute verbatim or modified
copies of this license document, and changing it is allowed as long
as the name is changed.
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. You just DO WHAT THE FUCK YOU WANT TO.
```
Loading…
Cancel
Save