Skip to content

Commit

Permalink
Formatted README, added reference to Python 3
Browse files Browse the repository at this point in the history
  • Loading branch information
Lazza committed Jan 16, 2021
1 parent 82fed97 commit 557b937
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,14 +58,17 @@ are exported in the directory specified by `-o` (or `recuperabit_output`).

### Limitation

Currently RecuperaBit does not work with compressed files on an NTFS filesystem. If you have deep knowledge of the inner workings of file compression on NTFS filesystem, your help would be much appreciated, as available documentation is quite sparse on the topic.
Currently RecuperaBit does not work with compressed files on an NTFS filesystem.
If you have deep knowledge of the inner workings of file compression on NTFS
filesystem, your help would be much appreciated, as available documentation is
quite sparse on the topic.

### Pypy

RecuperaBit can be run with the standard cPython implementation, however speed
can be increased by using it with the Pypy interpreter and JIT compiler:

pypy main.py /path/to/disk.img
pypy3 main.py /path/to/disk.img

### Docker
The container is built on top of debian:buster and pypy
Expand All @@ -87,7 +90,8 @@ Adjust the paths "*/path/to/*" to your needs
-v "/path/to/save.log:/save.log" \
h4r0/recuperabit

The arguments "-s, -o" and "path" are passed by default, if you want to run custom args specifiy them after "*h4r0/recuperabit*"
The arguments "-s, -o" and "path" are passed by default, if you want to run
custom args specifiy them after "*h4r0/recuperabit*"

docker run -it --rm \
-v "/path/to/drive.img:/drive.img" \
Expand Down

0 comments on commit 557b937

Please sign in to comment.