diff --git a/README.md b/README.md index 81382a2..dafbbad 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,32 @@ Valid language codes are: - por (Portuguese) - spa (Spanish) +### Additional OCR arguments +Below we will describe all available pipeline arguments that can be used. + + +- **_-i some/path_** + - Sets the input directory using the specified path. + - required = True + +- **_-o some/path_** + - Sets the output directory using the specified path. + - required = True + +- **_-l valid_language_code_** + - Tells tesseract which language will be used. + - required = True + +- **_--keep_intermediates_** + - Optional argument. If set all intermediate filese created during the OCR process will be kept. + - default = False + - required = False + +- **_--nCores_** + - Sets the number of CPU cores being used during the OCR process. + - default = min(4, multiprocessing.cpu_count()) + - required = False + ## Exit an re-enter the current running OCR process 1. You can leave the currently running OCR process by pressing `ctrl + a + d` and thus leaving the screen session. 2. Re-enter the screen session to check the status of the running OCR job with `screen -r `. (Try this if there is an error. `script -q -c "screen -r " /dev/null`).