Improve README with quick installation test - #11880
Conversation
Added a section for quick installation testing with an example.
WalkthroughREADME.md wording refined: the product is described as "an open-source proofreading software," the language list expanded, a sentence reworded to "It detects many errors...", and a new "Quick Installation Test" section added demonstrating a sample correction. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
README.md (2)
156-158: Consider using code formatting for example sentences.The example sentences could be more visually distinct using code blocks or inline code formatting:
Example:This are bad sentence.
LanguageTool should suggest:This is a bad sentence.
This makes the examples stand out more clearly as test input/output.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 156 - 158, Update the README example sentences to use code formatting so they stand out; replace the plain-text examples "This are bad sentence." and "This is a bad sentence." with a fenced code block (triple backticks) or inline code formatting in the README examples section so input/output are visually distinct and preserved as literal text.
152-158: Consider moving this section after installation instructions.The "Quick Installation Test" section appears after the License section, but it would flow more naturally immediately after the installation sections (after line 146, before the "How to run under Mac M1 or M2" section or before the License section). This would help users test their installation right after completing it.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 152 - 158, The "Quick Installation Test" section (heading "## Quick Installation Test") is placed after the License section; move that entire section so it appears immediately after the installation instructions (for example, after the installation block and before the "How to run under Mac M1 or M2" section or before the "License" heading) so users can run the simple test ("This are bad sentence.") right after completing installation; update any surrounding headings/TOC entries if present to reflect the new position.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 152-158: Update the "Quick Installation Test" section to include
explicit, actionable steps for running the test: add a command-line example
using the LanguageTool CLI (e.g., run java -jar languagetool-commandline.jar -l
en "This are bad sentence." and show the expected suggestion "This is a bad
sentence."), and optionally note brief GUI/server alternatives (open the GUI and
paste the sentence, or send the sentence to the server API endpoint) so users
know which interface to use and what exact command or action to perform for the
"Quick Installation Test" section.
---
Nitpick comments:
In `@README.md`:
- Around line 156-158: Update the README example sentences to use code
formatting so they stand out; replace the plain-text examples "This are bad
sentence." and "This is a bad sentence." with a fenced code block (triple
backticks) or inline code formatting in the README examples section so
input/output are visually distinct and preserved as literal text.
- Around line 152-158: The "Quick Installation Test" section (heading "## Quick
Installation Test") is placed after the License section; move that entire
section so it appears immediately after the installation instructions (for
example, after the installation block and before the "How to run under Mac M1 or
M2" section or before the "License" heading) so users can run the simple test
("This are bad sentence.") right after completing installation; update any
surrounding headings/TOC entries if present to reflect the new position.
| ## Quick Installation Test | ||
|
|
||
| After installing LanguageTool, you can verify it is working by testing a simple incorrect sentence. | ||
| Example: | ||
| "This are bad sentence." | ||
| LanguageTool should suggest: | ||
| "This is a bad sentence." |
There was a problem hiding this comment.
🛠️ Refactor suggestion | 🟠 Major
Provide actionable instructions for running the test.
The section describes WHAT to test but not HOW to test it. Users won't know which interface to use (GUI, command line, or server) or what commands to run.
Consider adding specific instructions, such as:
## Quick Installation Test
After installing LanguageTool, you can verify it is working by testing a simple incorrect sentence.
Using the command line:
```sh
java -jar languagetool-commandline.jar -l en "This are bad sentence."LanguageTool should detect errors and suggest: "This is a bad sentence."
Or provide instructions for the GUI or server interface, whichever is most appropriate for new users.
<details>
<summary>🤖 Prompt for AI Agents</summary>
Verify each finding against the current code and only fix it if needed.
In @README.md around lines 152 - 158, Update the "Quick Installation Test"
section to include explicit, actionable steps for running the test: add a
command-line example using the LanguageTool CLI (e.g., run java -jar
languagetool-commandline.jar -l en "This are bad sentence." and show the
expected suggestion "This is a bad sentence."), and optionally note brief
GUI/server alternatives (open the GUI and paste the sentence, or send the
sentence to the server API endpoint) so users know which interface to use and
what exact command or action to perform for the "Quick Installation Test"
section.
</details>
<!-- This is an auto-generated comment by CodeRabbit -->
There was a problem hiding this comment.
♻️ Duplicate comments (1)
README.md (1)
151-157:⚠️ Potential issue | 🟠 MajorProvide actionable instructions for running the test.
The section describes WHAT to test but not HOW to test it. Users won't know which interface to use (GUI, command line, or server) or what commands to run.
Consider adding specific instructions. For example, a command-line approach:
## Quick Installation Test After installing LanguageTool, you can verify it is working by testing a simple incorrect sentence. Using the command line: ```sh java -jar languagetool-commandline.jar -l en "This are bad sentence."LanguageTool should detect errors and suggest: "This is a bad sentence."
Or provide instructions for the GUI or server interface, whichever is most appropriate for new users. <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@README.mdaround lines 151 - 157, Update the "Quick Installation Test"
section to include concrete, actionable steps for running the test: under the
"Quick Installation Test" header, keep the example sentence "This are bad
sentence." and add a command-line example using the command "java -jar
languagetool-commandline.jar -l en "This are bad sentence."" with a note that
LanguageTool should detect the error and suggest "This is a bad sentence."; also
add a short GUI instruction telling users to open the LanguageTool desktop app
and paste the sentence to see corrections, and a brief server example using curl
against the server endpoint (e.g., POST to /v2/check with language=en and
text="This are bad sentence.") so readers have one-line runnable commands for
CLI and server plus the GUI alternative.</details> </blockquote></details> </blockquote></details> <details> <summary>🤖 Prompt for all review comments with AI agents</summary>Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In@README.md:
- Around line 151-157: Update the "Quick Installation Test" section to include
concrete, actionable steps for running the test: under the "Quick Installation
Test" header, keep the example sentence "This are bad sentence." and add a
command-line example using the command "java -jar languagetool-commandline.jar
-l en "This are bad sentence."" with a note that LanguageTool should detect
the error and suggest "This is a bad sentence."; also add a short GUI
instruction telling users to open the LanguageTool desktop app and paste the
sentence to see corrections, and a brief server example using curl against the
server endpoint (e.g., POST to /v2/check with language=en and text="This are bad
sentence.") so readers have one-line runnable commands for CLI and server plus
the GUI alternative.</details> --- <details> <summary>ℹ️ Review info</summary> **Configuration used**: Repository UI **Review profile**: CHILL **Plan**: Pro <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 5eda7ef3e83d029cbb77c183bc00d42ca1cc76b5 and c5c52c85efe1fc31c69dbc5bce55b0613d2dd718. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `README.md` </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
There was a problem hiding this comment.
♻️ Duplicate comments (1)
README.md (1)
151-157:⚠️ Potential issue | 🟠 MajorMissing actionable instructions for running the test.
The section shows WHAT to test but not HOW to run the test. Users won't know which interface (GUI, command line, or server) to use or what commands to execute.
This issue has been previously flagged and remains unresolved.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 151 - 157, Update the "Quick Installation Test" section to include explicit, actionable steps for running the test with each interface: (1) Command-line: show the exact command to run the LanguageTool CLI (reference the "Quick Installation Test" heading and the example sentence "This are bad sentence.") and describe how to provide the sentence and where the suggestion will appear; (2) Server/API: show the exact HTTP request pattern to POST the example sentence to the /v2/check endpoint with a language parameter and where to find the returned suggested correction; (3) GUI: state the UI steps to paste the sample sentence into the web/desktop GUI and click the "Check" button to see the suggested correction; ensure each step is concise and includes expected output "This is a bad sentence." so users can verify success.
🧹 Nitpick comments (2)
README.md (2)
154-157: Consider formatting improvements for the example.The example sentences would be more readable if formatted as code blocks.
📝 Suggested formatting improvement
-Example: -"This are bad sentence." -LanguageTool should suggest: -"This is a bad sentence." +Example: +``` +This are bad sentence. +``` +LanguageTool should suggest: +``` +This is a bad sentence. +```🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 154 - 157, Update the README example to use fenced code blocks for improved readability: wrap the input sentence "This are bad sentence." in a code block, place the label line "LanguageTool should suggest:" outside or above a second code block, and wrap the corrected sentence "This is a bad sentence." in its own fenced code block so both example input and suggested output are clearly formatted.
151-157: Consider relocating the section before the License.Placing user-facing documentation (like installation tests) after legal sections (License) is unconventional. Consider moving this section before line 146 (the License section) for better document flow.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 151 - 157, The "Quick Installation Test" section is placed after the License; move it so user-facing documentation appears before the License for better flow. Edit README.md to cut the "## Quick Installation Test" header and its example (the sentence test and expected suggestion) and paste it immediately above the "License" section (i.e., before the License header), ensuring the section header text "## Quick Installation Test" and its example remain unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@README.md`:
- Around line 151-157: Update the "Quick Installation Test" section to include
explicit, actionable steps for running the test with each interface: (1)
Command-line: show the exact command to run the LanguageTool CLI (reference the
"Quick Installation Test" heading and the example sentence "This are bad
sentence.") and describe how to provide the sentence and where the suggestion
will appear; (2) Server/API: show the exact HTTP request pattern to POST the
example sentence to the /v2/check endpoint with a language parameter and where
to find the returned suggested correction; (3) GUI: state the UI steps to paste
the sample sentence into the web/desktop GUI and click the "Check" button to see
the suggested correction; ensure each step is concise and includes expected
output "This is a bad sentence." so users can verify success.
---
Nitpick comments:
In `@README.md`:
- Around line 154-157: Update the README example to use fenced code blocks for
improved readability: wrap the input sentence "This are bad sentence." in a code
block, place the label line "LanguageTool should suggest:" outside or above a
second code block, and wrap the corrected sentence "This is a bad sentence." in
its own fenced code block so both example input and suggested output are clearly
formatted.
- Around line 151-157: The "Quick Installation Test" section is placed after the
License; move it so user-facing documentation appears before the License for
better flow. Edit README.md to cut the "## Quick Installation Test" header and
its example (the sentence test and expected suggestion) and paste it immediately
above the "License" section (i.e., before the License header), ensuring the
section header text "## Quick Installation Test" and its example remain
unchanged.
1 participant
Added a section for quick installation testing with an example.
Summary by CodeRabbit