Skip to content

Commit

Permalink
improved documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
makesourcenotcode committed Jan 6, 2024
1 parent bb1b0c1 commit bf38fa9
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.txt → README.dodge_help_information
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
=== SUMMARY ===

version: 1.0.5

You deleted your only copy of an OpenPGP private key file. You wonder if the key
material can be recovered via forensic techniques such as file carving.
( https://en.wikipedia.org/wiki/File_carving ) Happily you're in luck! Dodge
(named after the key obsessed demon in Locke & Key show) may be able to help!

=== VERSION ===

1.0.4

=== USAGE ===

Basic usage:
Expand Down Expand Up @@ -60,10 +58,11 @@ just for well off people with reliable Internet access. Learn more at:
https://makesourcenotcode.github.io/freedom_respecting_technology.html

It's (admittedly small) Open Knowledge Set consists of:
* the main program source/executable file dodge
licensed under GNU GPL v3 ( https://www.gnu.org/licenses/gpl-3.0.txt )
* the documentation / Help Information Set consisting of this file
licensed under GNU FDL v1.3 ( https://www.gnu.org/licenses/fdl-1.3.txt )
* the main program source file / executable file dodge licensed under
GNU GPL v3 ( https://www.gnu.org/licenses/gpl-3.0.txt )
* the source / built form of the documentation / Help Information Set consisting
of this file licensed under
GNU FDL v1.3 ( https://www.gnu.org/licenses/fdl-1.3.txt )

=== MOTIVATION AND DEVELOPMENT NOTES ===

Expand All @@ -81,6 +80,8 @@ That story is Thoroughly Entertaining. But for those short on time pages 67-75
contain the critical details you need to try that approach as well. Page 80 of
the slides is the approach I believe in retrospect would have been best.

The corresponding video may also prove amusing: https://vimeo.com/341007205

Namely find all offsets for the '-----BEGIN PGP PRIVATE KEY BLOCK-----' bytes in
the image, read some chunk of data from each such offset storing it in a
temporary file, try importing that temporary file with GnuPG which shouldn't be
Expand Down Expand Up @@ -165,6 +166,7 @@ single time I tried using it. Your luck may be better.

=== CHANGELOG ===

v1.0.5: improved documentation
v1.0.4: leverage grep more idiomatically
v1.0.3: fix documentation bugs
v1.0.2: fix documentation bugs
Expand Down

0 comments on commit bf38fa9

Please sign in to comment.