diff --git a/readme.md b/readme.md index b9a9e4b..04538d4 100644 --- a/readme.md +++ b/readme.md @@ -1,35 +1,34 @@ -# Sort files recoverd by Photorec +# Sort files recovered by Photorec Photorec does a great job when recovering deleted files. But the result is a huge, unsorted, unnamed amount of files. Especially for external hard drives serving as backup of all the personal data, sorting them is an endless job. This program sPRF helps you sorting your files. First of all, the **files are copied to own folders for each file type**. Second, **jpgs are distinguished by the year, and optionally by month as well** when they have been taken **and by the event**. We thereby define an event as a time span during them photos are taken. It has a delta of 4 days without a photo to another event. If no date from the past can be detected, these jpgs are put into one folder to be sorted manually. - ## Installation First install the package [exifread](https://pypi.python.org/pypi/ExifRead): -```pip install exifread``` +`pip install exifread` ## Run the sorter Then run the sorter: -```python recovery.py ``` +`python recovery.py ` -This copies the recovered file to their file type folder in the destination directory. The recovered files are not modified. If a file already exists in the destination directory, it is skipped. Hence you can interrupt the process with Ctrl+C and continue afterwards. +This copies the recovered files to their file type folder in the destination directory. The recovered files are not modified. If a file already exists in the destination directory, it is skipped. This means that the program can be interrupted with Ctrl+C and then continued at a later point by running it again. The first output of the programm is the number of files to copy. To count them might take some minutes depending on the amount of recovered files. Afterwareds you get some feedback on the processed files. ### Parameters -For an overview of all arguments, run with the `-h` option: ```python recovery.py -h```. +For an overview of all arguments, run with the `-h` option: `python recovery.py -h`. #### Max numbers of files per folder -All directories contain maximum 500 files. If one contains more, numbered subdirectories are created. If you want another file-limit, e.g. 1000, just put that number as third parameter to the execution of the programm: +All directories contain a maximum of 500 files by default. If there are more for a file type, numbered subdirectories are created. If you want another file-limit, e.g. 1000, pass that number as the third parameter when running the program: -```python recovery.py -n1000``` +`python recovery.py -n1000` #### Folder for each month @@ -47,7 +46,7 @@ destination Sometimes you might want to sort each year by month: -```python recovery.py -m``` +`python recovery.py -m` Now you get: @@ -69,16 +68,14 @@ destination Use the -k parameter to keep the original filenames: -```python recovery.py -k``` - +`python recovery.py -k` #### Adjust event distance For the case you want to reduce or increase the timespan between events, simply use the parameter -d. The default is 4: + ```python recovery.py -d10``` - - #### Rename jpg-files with ```_