From 010426d488adae315bc6f118b9367e1d5f5570c1 Mon Sep 17 00:00:00 2001 From: Ludy Date: Fri, 16 Feb 2024 23:42:56 +0100 Subject: [PATCH] Document (#803) * Update HowToAddNewLanguage.md * Update HowToUseOCR.md * Update LocalRunGuide.md * Update README.md * Update LocalRunGuide.md * Update README.md --------- Co-authored-by: Anthony Stirling <77850077+Frooodle@users.noreply.github.com> --- HowToAddNewLanguage.md | 4 ++-- HowToUseOCR.md | 2 +- LocalRunGuide.md | 4 ++-- README.md | 4 ++-- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/HowToAddNewLanguage.md b/HowToAddNewLanguage.md index 9f8e3f39..385ccbbc 100644 --- a/HowToAddNewLanguage.md +++ b/HowToAddNewLanguage.md @@ -12,7 +12,7 @@ https://github.com/Stirling-Tools/Stirling-PDF/blob/main/src/main/resources/temp and add a flag svg file to https://github.com/Stirling-Tools/Stirling-PDF/tree/main/src/main/resources/static/images/flags Any SVG flags are fine, i got most of mine from [here](https://flagicons.lipis.dev/) -If your language isnt represented by a flag just find whichever closely matches it, such as for Arabic i chose Saudi Arabia +If your language isn't represented by a flag just find whichever closely matches it, such as for Arabic i chose Saudi Arabia For example to add Polish you would add @@ -32,7 +32,7 @@ Copy and rename it to messages_{your data-language-code here}.properties, in the Then simply translate all property entries within that file and make a PR into main for others to use! -If you do not have a java IDE i am happy to verify the changes worked once you raise PR (but wont be able to verify the translations themselves) +If you do not have a java IDE i am happy to verify the changes worked once you raise PR (but won't be able to verify the translations themselves) diff --git a/HowToUseOCR.md b/HowToUseOCR.md index 388ab438..d3e5744c 100644 --- a/HowToUseOCR.md +++ b/HowToUseOCR.md @@ -2,7 +2,7 @@ This document provides instructions on how to add additional language packs for the OCR tab in Stirling-PDF, both inside and outside of Docker. -## My OCR used to work and now doesnt! +## My OCR used to work and now doesn't! Please update your tesseract docker volume path version from 4.00 to 5 ## How does the OCR Work diff --git a/LocalRunGuide.md b/LocalRunGuide.md index 3c9b2716..9858f300 100644 --- a/LocalRunGuide.md +++ b/LocalRunGuide.md @@ -65,7 +65,7 @@ sudo make install ``` ### Step 3: Install Additional Software -Next we need to install LibreOffice for conversions, ocrmypdf for OCR, and opencv for patern recognition functionality. +Next we need to install LibreOffice for conversions, ocrmypdf for OCR, and opencv for pattern recognition functionality. Install the following software: @@ -264,7 +264,7 @@ sudo systemctl restart stirlingpdf.service Remember to set the necessary environment variables before running the project if you want to customize the application the list can be seen in the main readme. -You can do this in the terminal by using the `export` command or -D arguements to java -jar command: +You can do this in the terminal by using the `export` command or -D argument to java -jar command: ```bash export APP_HOME_NAME="Stirling PDF" diff --git a/README.md b/README.md index 5876a7e2..b04da526 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ [![Docker Image Version (tag latest semver)](https://img.shields.io/docker/v/frooodle/s-pdf/latest)](https://github.com/Stirling-Tools/Stirling-PDF/) [![GitHub Repo stars](https://img.shields.io/github/stars/stirling-tools/stirling-pdf?style=social)](https://github.com/Stirling-Tools/stirling-pdf) [![Paypal Donate](https://img.shields.io/badge/Paypal%20Donate-yellow?style=flat&logo=paypal)](https://www.paypal.com/paypalme/froodleplex) -[![Github Sponser](https://img.shields.io/badge/Github%20Sponsor-yellow?style=flat&logo=github)](https://github.com/sponsors/Frooodle) +[![Github Sponsor](https://img.shields.io/badge/Github%20Sponsor-yellow?style=flat&logo=github)](https://github.com/sponsors/Frooodle) [![Deploy to DO](https://www.deploytodo.com/do-btn-blue.svg)](https://cloud.digitalocean.com/apps/new?repo=https://github.com/Stirling-Tools/Stirling-PDF/tree/digitalOcean&refcode=c3210994b1af) @@ -262,7 +262,7 @@ For API usage you must provide a header with 'X-API-Key' and the associated API - Redact text (Via UI not just automated way) - Add Forms - Multi page layout (Stich PDF pages together) support x rows y columns and custom page sizing -- Fill forms mannual and automatic +- Fill forms manually or automatically ### Q2: Why is my application downloading .htm files? This is an issue caused commonly by your NGINX configuration. The default file upload size for NGINX is 1MB, you need to add the following in your Nginx sites-available file. ``client_max_body_size SIZE;`` Where "SIZE" is 50M for example for 50MB files.