From 129a65612fb42bc9f76305ea674c3da21a4b6ac9 Mon Sep 17 00:00:00 2001 From: Shiz Date: Wed, 11 Aug 2021 01:52:07 +0200 Subject: [PATCH] doc: add README --- README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..c098ad0 --- /dev/null +++ b/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 + + 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. +```